gonebusy-ruby-client 0.0.2

data/lib/gonebusy/api_helper.rb

@@ -0,0 +1,149 @@
+module Gonebusy
+  class APIHelper
+    # Replaces template parameters in the given url
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Hash] The parameters to replace in the url
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        query_builder
+      else
+        # iterate and append parameters
+        parameters.each do |key, value|
+          replace_value = ''
+
+          if value.nil?
+            replace_value = ''
+          elsif value.instance_of? Array
+            value.map!{|element| CGI.escape(element.to_s)}
+            replace_value = value.join('/')
+          else
+            replace_value = CGI.escape(value.to_s)
+          end
+
+          # find the template parameter and replace it with its value
+          query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        end
+      end
+      return query_builder
+    end
+
+    # Appends the given set of parameters to the given query string
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Hash] The parameters to append
+    def self.append_url_with_query_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        return query_builder
+      else
+        # remove any nil values
+        parameters = parameters.reject { |_key, value| value.nil? }
+
+        # does the query string already has parameters
+        has_params = query_builder.include? '?'
+        separator = has_params ? '&' : '?'
+
+        # append query with separator and parameters and return
+        return query_builder << separator << URI.encode_www_form(parameters)
+      end
+    end
+
+    # Validates and processes the given Url
+    # @param [String] The given Url to process
+    # @return [String] Pre-processed Url as string
+    def self.clean_url(url)
+      # perform parameter validation
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # ensure that the urls are absolute
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # get the http protocol match
+      protocol = matches[1]
+      
+      # check if parameters exist
+      index = url.index('?')
+
+      # remove redundant forward slashes
+      query = url[protocol.length...(index != nil ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # get the parameters
+      parameters = index != nil ? url[url.index('?')...url.length] : ""
+
+      # return processed url
+      return protocol + query  + parameters
+    end	
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      begin
+        return JSON.parse(json)
+      rescue
+        raise TypeError, "Server responded with invalid JSON."
+      end
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = Hash.new
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode value, key)
+      end 
+      return encoded
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form of a hash.
+    def self.form_encode(obj, instance_name)
+      retval = Hash.new
+
+      # If this is a structure, resolve it's field names.
+      if obj.kind_of? BaseModel
+        obj = obj.to_hash
+      end
+      
+      # Create a form encoded hash for this object.
+      if obj == nil
+        nil         
+      elsif obj.instance_of? Array
+        obj.each_with_index do |value, index|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + index.to_s + "]"))
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + key + "]"))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      return retval
+    end
+  end
+end
+
+# extend types to support to_bool
+module ToBoolean
+  def to_bool
+    return true if self == true || self.to_s.strip =~ /^(true|yes|y|1)$/i
+    return false
+  end
+end
+
+class NilClass; include ToBoolean; end
+class TrueClass; include ToBoolean; end
+class FalseClass; include ToBoolean; end
+class Numeric; include ToBoolean; end
+class String; include ToBoolean; end

data/lib/gonebusy/configuration.rb

@@ -0,0 +1,16 @@
+module Gonebusy
+  class Configuration
+    # The base Uri for API calls
+    @base_uri = 'http://beta.gonebusy.com/api/v1'
+
+    # Set Authorization to "Token <your API key>"
+    @authorization = 'Token <your API key>'
+
+    # The attribute accessors for public properties
+    class << self
+      attr_accessor :base_uri
+      attr_accessor :authorization
+    end
+ 
+  end
+end

data/lib/gonebusy/controllers/base_controller.rb

@@ -0,0 +1,45 @@
+# This file was automatically generated for GoneBusy Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+
+module Gonebusy
+  class BaseController
+    attr_accessor :http_client, :http_call_back
+
+    @@http_client = FaradayClient.new(60)
+
+    @@global_headers = {
+      'user-agent' => 'APIMATIC 2.0'      
+    }
+
+    def initialize(http_client: nil, http_call_back: nil)
+      @http_client = http_client ||= @@http_client
+      @http_call_back = http_call_back
+    end
+
+    def validate_parameters(args)
+      args.each do |name, value|
+        if value == nil
+            raise ArgumentError.new "Required parameter #{name} cannot be nil."
+        end
+      end
+    end
+
+    def execute_request(request, binary: false) 
+      @http_call_back.on_before_request(request) if @http_call_back
+
+      request.headers = @@global_headers.clone.merge(request.headers)
+      
+      response = binary ? @http_client.execute_as_binary(request) : @http_client.execute_as_string(request)
+      context = HttpContext.new(request, response)
+
+      @http_call_back.on_after_response(context) if @http_call_back
+
+      return context
+    end
+
+    def validate_response(context)
+      if !context.response.status_code.between?(200, 208) #[200,208] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', context
+      end
+    end
+  end
+end

data/lib/gonebusy/controllers/bookings_controller.rb

@@ -0,0 +1,298 @@
+# This file was automatically generated for GoneBusy Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+
+module Gonebusy
+  class BookingsController < BaseController
+    @@instance = BookingsController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # Create a Booking with params
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [CreateBookingBody] create_booking_body Required parameter: the content of the request
+    # @return CreateBookingResponse response from the API call
+    def create_booking(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/bookings/new'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers, parameters: options['create_booking_body'].to_json
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 422
+        raise EntitiesErrorException.new '422 - Unprocessable Entity', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return CreateBookingResponse.from_hash(decoded)
+    end
+
+    # Return list of Bookings.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [Integer] page Optional parameter: Page offset to fetch.
+    # @param [Integer] per_page Optional parameter: Number of results to return per page.
+    # @param [String] states Optional parameter: Comma-separated list of Booking states to retrieve only Bookings in those states.  Leave blank to retrieve all Bookings.
+    # @param [Integer] user_id Optional parameter: Retrieve Bookings owned only by this User Id.  You must be authorized to manage this User Id.
+    # @return GetBookingsResponse response from the API call
+    def get_bookings(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/bookings'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'page' => options['page'],
+        'per_page' => options['per_page'],
+        'states' => options['states'],
+        'user_id' => options['user_id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return GetBookingsResponse.from_hash(decoded)
+    end
+
+    # Cancel a Booking by id
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [String] id Required parameter: Example: 
+    # @return CancelBookingByIdResponse response from the API call
+    def cancel_booking_by_id(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/bookings/{id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => options['id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.delete _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return CancelBookingByIdResponse.from_hash(decoded)
+    end
+
+    # Update a Booking by id
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [String] id Required parameter: Example: 
+    # @return UpdateBookingByIdResponse response from the API call
+    def update_booking_by_id(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/bookings/{id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => options['id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.put _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 422
+        raise EntitiesErrorException.new '422 - Unprocessable Entity', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return UpdateBookingByIdResponse.from_hash(decoded)
+    end
+
+    # Return a Booking by id.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [String] id Required parameter: Example: 
+    # @return GetBookingByIdResponse response from the API call
+    def get_booking_by_id(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/bookings/{id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => options['id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return GetBookingByIdResponse.from_hash(decoded)
+    end
+  end
+end