supersaas-api-client 1.1.1 → 2.0.1

data/lib/supersaas-api-client/api/base_api.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Supersaas
   class BaseApi
     attr_accessor :client
 
-    INTEGER_REGEX = /\A[0-9]+\Z/
-    DATETIME_REGEX = /\A\d{4}-\d{1,2}-\d{1,2}\s\d{1,2}:\d{1,2}:\d{1,2}\Z/
+    INTEGER_REGEX = /\A[0-9]+\Z/.freeze
+    DATETIME_REGEX = /\A\d{4}-\d{1,2}-\d{1,2}\s\d{1,2}:\d{1,2}:\d{1,2}\Z/.freeze
+    PROMOTION_REGEX = /\A[0-9a-zA-Z]+\Z/.freeze
 
     def initialize(client)
       @client = client
@@ -17,39 +20,82 @@ module Supersaas
       elsif value.is_a?(String) && value =~ INTEGER_REGEX
         value.to_i
       else
-        raise Supersaas::Exception.new("Invalid id parameter: #{value}. Provide a integer value.")
+        raise Supersaas::Exception, "Invalid id parameter: #{value}. Provide a integer value."
+      end
+    end
+
+    def validate_user(value)
+      return if value.nil?
+
+      unless value.is_a?(Integer) || value.is_a?(String)
+        raise Supersaas::Exception, "Invalid user id parameter: #{value}."
+      end
+
+      value
+    end
+
+    def validate_number(value)
+      validate_id(value)
+    end
+
+    def validate_name(value)
+      unless value.nil? || (value.is_a?(String) && value.size)
+        raise Supersaas::Exception, 'Required parameter name is missing.'
       end
+
+      value
     end
-    def validate_number(value); validate_id(value); end
 
     def validate_present(value)
-      if value.is_a?(String) ? value.size : value
-        value
-      else
-        raise Supersaas::Exception.new("Required parameter is missing.")
+      raise Supersaas::Exception, 'Required parameter is missing.' unless value
+
+      value
+    end
+
+    def validate_notfound(value)
+      unless value.is_a?(String) && %w[error ignore].include?(value)
+        raise Supersaas::Exception, "Required parameter notfound can only be 'error' or 'ignore'."
       end
+
+      value
     end
 
-    def validate_datetime(value)
-      begin
-        if value.is_a?(String) && value =~ DATETIME_REGEX
-          value
-        elsif value.is_a?(Time) || value.is_a?(DateTime)
-          value.strftime("%Y-%m-%d %H:%M:%S")
-        else
-          raise ArgumentError
-        end
-      rescue ArgumentError
-        raise Supersaas::Exception.new("Invalid datetime parameter: #{value}. Provide a Time object or formatted 'YYYY-DD-MM HH:MM:SS' string.")
+    def validate_promotion(value)
+      unless value.is_a?(String) && value.size && value =~ PROMOTION_REGEX
+        raise Supersaas::Exception,
+              'Required parameter promotional code not found or contains other than alphanumeric characters.'
       end
+
+      value
     end
 
-    def validate_options(value, options)
-      if options.include?(value)
+    def validate_duplicate(value)
+      unless value.is_a?(String) && %w[ignore raise].include?(value)
+        raise Supersaas::Exception, "Required parameter duplicate can only be 'ignore'."
+      end
+
+      value
+    end
+
+    def validate_datetime(value)
+      if value.is_a?(String) && value =~ DATETIME_REGEX
         value
+      elsif value.is_a?(Time) || value.is_a?(DateTime)
+        value.strftime('%Y-%m-%d %H:%M:%S')
       else
-        raise Supersaas::Exception.new("Invalid option parameter: #{value}. Must be one of #{options.join(', ')}.")
+        raise ArgumentError
       end
+    rescue ArgumentError
+      raise Supersaas::Exception,
+            "Invalid datetime parameter: #{value}. Provide a Time object or formatted 'YYYY-DD-MM HH:MM:SS' string."
+    end
+
+    def validate_options(value, options)
+      unless options.include?(value)
+        raise Supersaas::Exception, "Invalid option parameter: #{value}. Must be one of #{options.join(', ')}."
+      end
+
+      value
     end
   end
-end
+end

data/lib/supersaas-api-client/api/forms.rb

@@ -1,21 +1,28 @@
+# frozen_string_literal: true
+
 module Supersaas
   # REF: https://www.supersaas.com/info/dev/form_api
   class Forms < BaseApi
-    def list(template_form_id, from_time=nil)
-      path = "/forms"
-      params = {
-        form_id: validate_id(template_form_id),
-        from: from_time ? validate_datetime(from_time) : nil
-      }
+    def list(template_form_id, from_time = nil, user = nil)
+      path = '/forms'
+      params = { form_id: validate_id(template_form_id) }
+      params.merge!(from: validate_datetime(from_time)) if from_time
+      params.merge!(user: validate_user(user)) if user
       res = client.get(path, params)
       res.map { |attributes| Supersaas::Form.new(attributes) }
     end
 
     def get(form_id)
-      path = "/forms"
-      params = {id: validate_id(form_id)}
+      path = '/forms'
+      params = { id: validate_id(form_id) }
       res = client.get(path, params)
       Supersaas::Form.new(res)
     end
+
+    def forms
+      path = '/super_forms'
+      res = client.get(path)
+      res.map { |attributes| Supersaas::SuperForm.new(attributes) }
+    end
   end
-end
+end

data/lib/supersaas-api-client/api/groups.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Supersaas
+  class Groups < BaseApi
+    # REF: https://www.supersaas.com/info/dev/information_api#groups
+    def list
+      path = '/groups'
+      res = client.get(path)
+      res.map { |attributes| Supersaas::Group.new(attributes) }
+    end
+  end
+end

data/lib/supersaas-api-client/api/promotions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Supersaas
+  class Promotions < BaseApi
+    # REF: https://www.supersaas.com/info/dev/promotion_api
+    def list(limit = nil, offset = nil)
+      path = '/promotions'
+      params = {
+        limit: limit && validate_number(limit),
+        offset: offset && validate_number(offset)
+      }
+      res = client.get(path, params)
+      res.map { |attributes| Supersaas::Promotion.new(attributes) }
+    end
+
+    def promotion(promotion_code)
+      path = '/promotions'
+      query = { promotion_code: validate_promotion(promotion_code) }
+      res = client.get(path, query)
+      res.map { |attributes| Supersaas::Promotion.new(attributes) }
+    end
+
+    def duplicate_promotion_code(promotion_code, template_code)
+      path = '/promotions'
+      query = { id: validate_promotion(promotion_code), template_code: validate_promotion(template_code) }
+      client.post(path, query)
+    end
+  end
+end

data/lib/supersaas-api-client/api/schedules.rb

@@ -1,16 +1,26 @@
+# frozen_string_literal: true
+
 module Supersaas
   class Schedules < BaseApi
+    # REF: https://www.supersaas.com/info/dev/information_api
     def list
-      path = "/schedules"
+      path = '/schedules'
       res = client.get(path)
       res.map { |attributes| Supersaas::Schedule.new(attributes) }
     end
 
     def resources(schedule_id)
-      path = "/resources"
-      query = {schedule_id: validate_id(schedule_id)}
+      path = '/resources'
+      query = { schedule_id: validate_id(schedule_id) }
       res = client.get(path, query)
       res.map { |attributes| Supersaas::Resource.new(attributes) }
     end
+
+    def field_list(schedule_id)
+      path = '/field_list'
+      query = { schedule_id: validate_id(schedule_id) }
+      res = client.get(path, query)
+      res.map { |attributes| Supersaas::FieldList.new(attributes) }
+    end
   end
-end
+end

data/lib/supersaas-api-client/api/users.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Supersaas
   # REF: https://www.supersaas.com/info/dev/user_api
   class Users < BaseApi
-    def list(form=nil, limit=nil, offset=nil)
+    def list(form = nil, limit = nil, offset = nil)
       path = user_path(nil)
       params = {
-          form: form ? true : nil,
-          limit: limit && validate_number(limit),
-          offset: offset && validate_number(offset)
+        form: form ? true : nil,
+        limit: limit && validate_number(limit),
+        offset: offset && validate_number(offset)
       }
       res = client.get(path, params)
       res.map { |attributes| Supersaas::User.new(attributes) }
@@ -18,12 +20,13 @@ module Supersaas
       Supersaas::User.new(res)
     end
 
-    def create(attributes, user_id=nil, webhook=nil)
+    def create(attributes, user_id = nil, webhook = nil, duplicate = nil)
       path = user_path(user_id)
-      query = {webhook: webhook}
+      query = { webhook: webhook }
+      query.merge!(duplicate: validate_duplicate(duplicate)) if duplicate
       params = {
         user: {
-          name: validate_present(attributes[:name]),
+          name: validate_name(attributes[:name]),
           email: attributes[:email],
           password: attributes[:password],
           full_name: attributes[:full_name],
@@ -31,6 +34,7 @@ module Supersaas
           mobile: attributes[:mobile],
           phone: attributes[:phone],
           country: attributes[:country],
+          timezone: attributes[:timezone],
           field_1: attributes[:field_1],
           field_2: attributes[:field_2],
           super_field: attributes[:super_field],
@@ -41,12 +45,13 @@ module Supersaas
       client.post(path, params, query)
     end
 
-    def update(user_id, attributes, webhook=nil)
-      path = user_path(validate_id(user_id))
-      query = {webhook: webhook}
+    def update(user_id, attributes, webhook = nil, notfound = nil)
+      path = user_path(user_id)
+      query = { webhook: webhook }
+      query.merge!(notfound: validate_notfound(notfound)) if notfound
       params = {
         user: {
-          name: attributes[:name],
+          name: validate_name(attributes[:name]),
           email: attributes[:email],
           password: attributes[:password],
           full_name: attributes[:full_name],
@@ -54,6 +59,7 @@ module Supersaas
           mobile: attributes[:mobile],
           phone: attributes[:phone],
           country: attributes[:country],
+          timezone: attributes[:timezone],
           field_1: attributes[:field_1],
           field_2: attributes[:field_2],
           super_field: attributes[:super_field],
@@ -61,22 +67,29 @@ module Supersaas
           role: attributes[:role] && validate_options(attributes[:role], User::ROLES)
         }
       }
+      params[:user].compact!
       client.put(path, params, query)
     end
 
     def delete(user_id)
-      path = user_path(validate_id(user_id))
+      path = user_path(user_id)
       client.delete(path)
     end
 
+    def field_list
+      path = '/field_list'
+      res = client.get(path)
+      res.map { |attributes| Supersaas::FieldList.new(attributes) }
+    end
+
     private
 
     def user_path(user_id)
       if user_id.nil? || user_id == ''
-        "/users"
+        '/users'
       else
-        "/users/#{user_id}"
+        "/users/#{validate_user(user_id)}"
       end
     end
   end
-end
+end

data/lib/supersaas-api-client/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'uri'
 require 'json'
@@ -24,8 +26,8 @@ module Supersaas
     attr_accessor :account_name, :api_key, :host, :dry_run, :verbose
     attr_reader :last_request
 
-    def initialize(configuration=nil)
-      configuration = configuration || Configuration.new
+    def initialize(configuration = nil)
+      configuration ||= Configuration.new
       @account_name = configuration.account_name
       @api_key = configuration.api_key
       @host = configuration.host
@@ -33,32 +35,70 @@ module Supersaas
       @verbose = configuration.verbose
     end
 
-    def appointments; @appointments ||= Appointments.new(self); end
-    def forms; @forms ||= Forms.new(self); end
-    def schedules; @schedules ||= Schedules.new(self); end
-    def users; @users ||= Users.new(self); end
+    def appointments
+      @appointments ||= Appointments.new(self)
+    end
+
+    def forms
+      @forms ||= Forms.new(self)
+    end
+
+    def schedules
+      @schedules ||= Schedules.new(self)
+    end
+
+    def users
+      @users ||= Users.new(self)
+    end
 
-    def get(path, query={})
+    def promotions
+      @promotions ||= Promotions.new(self)
+    end
+
+    def groups
+      @groups ||= Groups.new(self)
+    end
+
+    def get(path, query = {})
       request(:get, path, {}, query)
     end
 
-    def post(path, params={}, query={})
+    def post(path, params = {}, query = {})
       request(:post, path, params, query)
     end
 
-    def put(path, params={}, query={})
+    def put(path, params = {}, query = {})
       request(:put, path, params, query)
     end
 
-    def delete(path, params={}, query={})
+    def delete(path, params = {}, query = {})
       request(:delete, path, params, query)
     end
 
     private
 
-    def request(http_method, path, params={}, query={})
-      raise Supersaas::Exception.new("Account name not configured. Call `Supersaas::Client.configure`.") unless account_name && account_name.size
-      raise Supersaas::Exception.new("Account api key not configured. Call `Supersaas::Client.configure`.") unless api_key && api_key.size
+    # The rate limiter allows a maximum of 4 requests within the specified time window
+    WINDOW_SIZE = 1 # seconds
+    MAX_PER_WINDOW = 4
+    def throttle
+      # A queue to store timestamps of requests made within the rate limiting window
+      @queue ||= Array.new(MAX_PER_WINDOW)
+      # Represents the timestamp of the oldest request within the time window
+      oldest_request = @queue.push(Time.now).shift
+      # This ensures that the client does not make requests faster than the defined rate limit
+      if oldest_request && (d = Time.now - oldest_request) < WINDOW_SIZE
+        sleep WINDOW_SIZE - d
+      end
+    end
+
+    def request(http_method, path, params = {}, query = {})
+      throttle
+      unless account_name&.size
+        raise Supersaas::Exception, 'Account name not configured. Call `Supersaas::Client.configure`.'
+      end
+      unless api_key&.size
+        raise Supersaas::Exception, 'Account api key not configured. Call `Supersaas::Client.configure`.'
+      end
 
       uri = URI.parse(host)
       http = Net::HTTP.new(uri.host, uri.port)
@@ -68,7 +108,7 @@ module Supersaas
       query = delete_blank_values query
 
       path = "/api#{path}.json"
-      path += "?#{URI.encode_www_form(query)}" if query.keys.size > 0
+      path += "?#{URI.encode_www_form(query)}" if query.keys.size.positive?
 
       case http_method
       when :get
@@ -83,7 +123,8 @@ module Supersaas
         req = Net::HTTP::Delete.new(path)
         req.body = params.to_json
       else
-        raise Supersaas::Exception.new("Invalid HTTP Method: #{http_method}. Only `:get`, `:post`, `:put`, `:delete` supported.")
+        raise Supersaas::Exception,
+              "Invalid HTTP Method: #{http_method}. Only `:get`, `:post`, `:put`, `:delete` supported."
       end
 
       req.basic_auth account_name, api_key
@@ -93,10 +134,10 @@ module Supersaas
       req['User-Agent'] = self.class.user_agent
 
       if verbose
-        puts "### SuperSaaS Client Request:"
+        puts '### SuperSaaS Client Request:'
         puts "#{http_method} #{path}"
         puts params.to_json
-        puts "------------------------------"
+        puts '------------------------------'
       end
 
       @last_request = req
@@ -106,13 +147,14 @@ module Supersaas
         res = http.request(req)
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
         Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
-        raise Supersaas::Exception.new("HTTP Request Error (#{uri}#{path}): #{e.message}")
+        raise Supersaas::Exception, "HTTP Request Error (#{uri}#{path}): #{e.message}"
       end
 
       if verbose
-        puts "Response:"
+        puts 'Response:'
+        puts res.inspect
         puts res.body
-        puts "=============================="
+        puts '=============================='
       end
 
       code = res.code.to_i
@@ -123,29 +165,53 @@ module Supersaas
         else
           json_body(res)
         end
-      when 422, 400
-        json_body(res)
+      else
+        handle_errors(code, res)
+      end
+    end
+
+    def handle_errors(code, res)
+      print_errors(res)
+      case code
+      when 422
+        raise Supersaas::Exception, 'HTTP Request Error: Unprocessable Content'
+      when 400
+        raise Supersaas::Exception, 'HTTP Request Error: Bad Request'
       when 401
-        raise Supersaas::Exception.new("HTTP Request Error: Unauthorised")
+        raise Supersaas::Exception, 'HTTP Request Error: Unauthorised'
       when 404
-        raise Supersaas::Exception.new("HTTP Request Error: Not Found")
+        raise Supersaas::Exception, 'HTTP Request Error: Not Found'
+      when 501
+        raise Supersaas::Exception, 'Not yet implemented for service type schedule'
+      when 403
+        raise Supersaas::Exception, 'Unauthorized'
+      when 405
+        raise Supersaas::Exception, 'Not available for capacity type schedule'
       else
-        {}
+        raise Supersaas::Exception, "HTTP Request Error: #{code}"
       end
     end
 
-    def json_body(res)
-      begin
-        res.body && res.body.size ? JSON.parse(res.body) : {}
-      rescue JSON::ParserError
-        {}
+    def print_errors(res)
+      json_body = json_body(res)
+      return unless json_body[:errors]
+
+      errors each do |error|
+        puts "Error code: #{error['code']}, #{error['title']}"
       end
     end
 
+    def json_body(res)
+      res.body&.size ? JSON.parse(res.body) : {}
+    rescue JSON::ParserError
+      {}
+    end
+
     def delete_blank_values(hash)
       return hash unless hash
-      hash.delete_if do |k, v|
-        v = v.delete_if { |k2, v2| v2.nil? } if (v.is_a?(Hash))
+
+      hash.delete_if do |_k, v|
+        v = v.compact if v.is_a?(Hash)
         v.nil? || v == ''
       end
     end
@@ -156,12 +222,12 @@ module Supersaas
       attr_accessor :account_name, :host, :api_key, :dry_run, :verbose
 
       def initialize
-        @account_name = ENV['SSS_API_ACCOUNT_NAME']
-        @api_key = ENV['SSS_API_KEY']
+        @account_name = ENV.fetch('SSS_API_ACCOUNT_NAME', nil)
+        @api_key = ENV.fetch('SSS_API_KEY', nil)
         @host = DEFAULT_HOST
         @dry_run = false
         @verbose = false
       end
     end
   end
-end
+end

data/lib/supersaas-api-client/exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Supersaas
   class Exception < StandardError
     @field = nil
@@ -5,4 +7,4 @@ module Supersaas
 
     attr_accessor :field, :code
   end
-end
+end

data/lib/supersaas-api-client/models/appointment.rb

@@ -1,22 +1,19 @@
+# frozen_string_literal: true
+
 module Supersaas
   class Appointment < BaseModel
-    attr_accessor :address, :country, :created_by, :created_on, :deleted, :description, :email, :field_1, :field_2, :field_1_r, :field_2_r, :finish, :form_id, :full_name, :id, :mobile, :name, :phone, :price, :res_name, :resource_id, :schedule_id, :schedule_name, :service_id, :service_name, :slot_id, :start, :status, :super_field, :updated_by, :updated_on, :user_id, :waitlisted
+    attr_accessor :address, :country, :created_by, :created_on, :deleted, :description, :email, :field_1, :field_2,
+                  :field_1_r, :field_2_r, :finish, :form_id, :full_name, :id, :mobile, :name, :phone, :price, :res_name,
+                  :resource_id, :schedule_id, :schedule_name, :service_id, :service_name, :slot_id, :start, :status,
+                  :super_field, :updated_by, :updated_on, :user_id, :waitlisted
     attr_reader :form, :slot
 
     def form=(value)
-      if value.is_a?(Hash)
-        @form = Supersaas::Form.new(value)
-      else
-        @form = value
-      end
+      @form = value.is_a?(Hash) ? Supersaas::Form.new(value) : value
     end
 
     def slot=(value)
-      if value.is_a?(Hash)
-        @slot = Supersaas::Slot.new(value)
-      else
-        @slot = value
-      end
+      @slot = value.is_a?(Hash) ? Supersaas::Slot.new(value) : value
     end
   end
-end
+end

data/lib/supersaas-api-client/models/base_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Supersaas
   class BaseModel
     attr_accessor :errors
@@ -12,8 +14,9 @@ module Supersaas
 
     def assign_attributes(attributes)
       attributes.each do |key, value|
+        self.class.module_eval { attr_accessor key }
         public_send("#{key}=", value) if respond_to?("#{key}=")
       end
     end
   end
-end
+end

data/lib/supersaas-api-client/models/field_list.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Supersaas
+  class FieldList < BaseModel
+    attr_accessor :name, :type, :label, :advanced
+    attr_reader :spec
+
+    def spec=(value)
+      @spec = value.is_a?(Array) ? value.map { |attributes| JSON.parse(attributes) } : value
+    end
+  end
+end

data/lib/supersaas-api-client/models/form.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Supersaas
   class Form < BaseModel
-    attr_accessor :content, :created_on, :deleted, :id, :reservation_process_id, :super_form_id, :uniq, :updated_name, :updated_on, :user_id
+    attr_accessor :content, :created_on, :deleted, :id, :reservation_process_id, :super_form_id, :uniq, :updated_name,
+                  :updated_on, :user_id
   end
-end
+end

data/lib/supersaas-api-client/models/group.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Supersaas
+  class Group < BaseModel
+    attr_accessor :id, :name
+  end
+end

data/lib/supersaas-api-client/models/promotion.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Supersaas
+  class Promotion < BaseModel
+    attr_accessor :id, :code, :description, :usage
+  end
+end

data/lib/supersaas-api-client/models/resource.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Supersaas
   class Resource < BaseModel
     attr_accessor :id, :name
   end
-end
+end