supersaas-api-client 1.1.0 → 2.0.0

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,42 +147,71 @@ 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
       case code
       when 200, 201
-        json_body(res)
-      when 422, 400
-        json_body(res)
+        if http_method == :post && res['location'] =~ /www.supersaas.com/
+          res['location']
+        else
+          json_body(res)
+        end
+      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
@@ -152,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

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

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

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

@@ -1,14 +1,12 @@
+# frozen_string_literal: true
+
 module Supersaas
   class Slot < BaseModel
     attr_accessor :count, :description, :finish, :id, :location, :name, :start, :title
     attr_reader :bookings
 
     def bookings=(value)
-      if value.is_a?(Array)
-        @bookings = value.map {|attributes| Supersaas::Appointment.new(attributes) }
-      else
-        @bookings = value
-      end
+      @bookings = value.is_a?(Array) ? value.map { |attributes| Supersaas::Appointment.new(attributes) } : value
     end
   end
-end
+end

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

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

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

@@ -1,16 +1,13 @@
+# frozen_string_literal: true
+
 module Supersaas
   class User < BaseModel
-    ROLES = [3, 4, -1]
+    ROLES = [3, 4, -1].freeze
 
-    attr_accessor :address, :country, :created_on, :credit, :email, :field_1, :field_2, :fk, :full_name, :id, :mobile, :name, :phone, :role, :super_field
     attr_reader :form
 
     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
   end
-end
+end

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Supersaas
-  API_VERSION  = '2'
-  VERSION = '1.1.0'
+  API_VERSION = '3'
+  VERSION = '2.0.0'
 end

data/lib/supersaas-api-client.rb

@@ -1 +1,3 @@
-require_relative './supersaas'
+# frozen_string_literal: true
+
+require_relative 'supersaas'

data/lib/supersaas.rb

@@ -1,15 +1,23 @@
-require "supersaas-api-client/version"
-require "supersaas-api-client/exception"
-require "supersaas-api-client/models/base_model"
-require "supersaas-api-client/models/appointment"
-require "supersaas-api-client/models/form"
-require "supersaas-api-client/models/resource"
-require "supersaas-api-client/models/schedule"
-require "supersaas-api-client/models/slot"
-require "supersaas-api-client/models/user"
-require "supersaas-api-client/api/base_api"
-require "supersaas-api-client/api/appointments"
-require "supersaas-api-client/api/forms"
-require "supersaas-api-client/api/schedules"
-require "supersaas-api-client/api/users"
-require "supersaas-api-client/client"
+# frozen_string_literal: true
+
+require 'supersaas-api-client/version'
+require 'supersaas-api-client/exception'
+require 'supersaas-api-client/models/base_model'
+require 'supersaas-api-client/models/appointment'
+require 'supersaas-api-client/models/field_list'
+require 'supersaas-api-client/models/form'
+require 'supersaas-api-client/models/super_form'
+require 'supersaas-api-client/models/group'
+require 'supersaas-api-client/models/resource'
+require 'supersaas-api-client/models/schedule'
+require 'supersaas-api-client/models/promotion'
+require 'supersaas-api-client/models/slot'
+require 'supersaas-api-client/models/user'
+require 'supersaas-api-client/api/base_api'
+require 'supersaas-api-client/api/appointments'
+require 'supersaas-api-client/api/forms'
+require 'supersaas-api-client/api/schedules'
+require 'supersaas-api-client/api/groups'
+require 'supersaas-api-client/api/promotions'
+require 'supersaas-api-client/api/users'
+require 'supersaas-api-client/client'

data/supersaas-api-client.gemspec

@@ -1,27 +1,28 @@
-$:.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
 
-require "supersaas-api-client/version"
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'supersaas-api-client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "supersaas-api-client"
+  spec.name          = 'supersaas-api-client'
   spec.version       = Supersaas::VERSION
-  spec.authors       = ["Travis Dunn"]
-  spec.email         = ["travis@supersaas.com"]
+  spec.authors       = ['Kaarle Kulvik']
+  spec.email         = ['kaarle@supersaas.com']
 
-  spec.summary       = %q{Online bookings/appointments/calendars using the SuperSaaS scheduling platform.}
-  spec.description   = %q{Online appointment scheduler for any type of business. Flexible and affordable booking software that can be integrated into any site. Free basic version.}
-  spec.homepage      = "https://www.supersaas.com"
-  spec.license       = "MIT"
+  spec.summary       = 'Manage appointments and users on the SuperSaaS scheduling platform'
+  spec.description   = 'Online appointment scheduling for any type of business. Flexible and affordable booking software that can be integrated into any site. Free basic version.'
+  spec.homepage      = 'https://www.supersaas.com'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test)/})
-  end
-  spec.test_files    = Dir['test/**/*']
-  spec.bindir        = "bin"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.17.3"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end