supersaas-api-client 0.9.0

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

@@ -0,0 +1,152 @@
+module Supersaas
+  # REF: https://www.supersaas.com/info/dev/appointment_api
+  class Appointments < BaseApi
+    def agenda(schedule_id, user_id, from_time=nil)
+      path = "/agenda/#{validate_id(schedule_id)}"
+      params = {
+        user: validate_present(user_id),
+        from: from_time && validate_datetime(from_time)
+      }
+      res = client.get(path, params)
+      map_slots_or_bookings(res)
+    end
+
+    def agenda_slots(schedule_id, user_id, from_time=nil)
+      path = "/agenda/#{validate_id(schedule_id)}"
+      params = {
+        user: validate_present(user_id),
+        from: from_time && validate_datetime(from_time),
+        slot: true
+      }
+      res = client.get(path, params)
+      map_slots_or_bookings(res, true)
+    end
+
+    def available(schedule_id, from_time, length_minutes=nil, resource=nil, full=nil, limit=nil)
+      path = "/free/#{validate_id(schedule_id)}"
+      params = {
+        length: length_minutes && validate_number(length_minutes),
+        from: validate_datetime(from_time),
+        resource: resource,
+        full: full ? true : nil,
+        maxresults: limit && validate_number(limit)
+      }
+      res = client.get(path, params)
+      map_slots_or_bookings(res)
+    end
+
+    def list(schedule_id, form=nil, start_time=nil, limit=nil)
+      path = "/bookings"
+      params = {
+          schedule_id: validate_id(schedule_id),
+          form: form ? true : nil,
+          start: start_time ? validate_datetime(start_time) : nil,
+          limit: limit && validate_number(limit)
+      }
+      res = client.get(path, params)
+      map_slots_or_bookings(res)
+    end
+
+    def get(schedule_id, appointment_id)
+      params = {schedule_id: validate_id(schedule_id)}
+      path = "/bookings/#{validate_id(appointment_id)}"
+      res = client.get(path, params)
+      Supersaas::Appointment.new(res)
+    end
+
+    def create(schedule_id, user_id, attributes, form=nil, webhook=nil)
+      path = "/bookings"
+      params = {
+        schedule_id: schedule_id,
+        webhook: webhook,
+        user_id: validate_id(user_id),
+        form: form ? true : nil,
+        booking: {
+          start: attributes[:start],
+          finish: attributes[:finish],
+          name: attributes[:name],
+          email: attributes[:email],
+          full_name: attributes[:full_name],
+          address: attributes[:address],
+          mobile: attributes[:mobile],
+          phone: attributes[:phone],
+          country: attributes[:country],
+          field_1: attributes[:field_1],
+          field_2: attributes[:field_2],
+          field_1_r: attributes[:field_1_r],
+          field_2_r: attributes[:field_2_r],
+          super_field: attributes[:super_field],
+          resource_id: attributes[:resource_id],
+          slot_id: attributes[:slot_id]
+        }
+      }
+      client.post(path, params)
+    end
+
+    def update(schedule_id, appointment_id, attributes, form=nil, webhook=nil)
+      path = "/bookings/#{validate_id(appointment_id)}"
+      params = {
+        schedule_id: schedule_id,
+        webhook: webhook,
+        form: form,
+        booking: {
+          start: attributes[:start],
+          finish: attributes[:finish],
+          name: validate_present(attributes[:name]),
+          email: attributes[:email],
+          full_name: attributes[:full_name],
+          address: attributes[:address],
+          mobile: attributes[:mobile],
+          phone: attributes[:phone],
+          country: attributes[:country],
+          field_1: attributes[:field_1],
+          field_2: attributes[:field_2],
+          field_1_r: attributes[:field_1_r],
+          field_2_r: attributes[:field_2_r],
+          super_field: attributes[:super_field],
+          resource_id: attributes[:resource_id],
+          slot_id: attributes[:slot_id]
+        }
+      }
+      client.put(path, params)
+    end
+
+    def delete(appointment_id)
+      path = "/bookings/#{validate_id(appointment_id)}"
+      client.delete(path)
+    end
+
+    def changes(schedule_id, from_time)
+      path = "/changes/#{validate_id(schedule_id)}"
+      params = { from: validate_datetime(from_time) }
+      res = client.get(path, params)
+      map_slots_or_bookings(res)
+    end
+
+    def changes_slots(schedule_id, from_time)
+      path = "/changes/#{validate_id(schedule_id)}"
+      params = {
+        from: validate_datetime(from_time),
+        slot: true
+      }
+      res = client.get(path, params)
+      map_slots_or_bookings(res, true)
+    end
+
+    private
+
+    def map_slots_or_bookings(obj, slot=false)
+      if obj.is_a?(Array) && slot
+        obj.map { |attributes| Supersaas::Slot.new(attributes) }
+      elsif obj.is_a?(Array)
+        obj.map { |attributes| Supersaas::Appointment.new(attributes) }
+      elsif obj['slots']
+        obj['slots'].map { |attributes| Supersaas::Slot.new(attributes) }
+      elsif obj['bookings']
+        obj['bookings'].map { |attributes| Supersaas::Appointment.new(attributes) }
+      else
+        []
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+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/
+
+    def initialize(client)
+      @client = client
+    end
+
+    protected
+
+    def validate_id(value)
+      if value.is_a?(Integer)
+        value
+      elsif value.is_a?(String) && value =~ INTEGER_REGEX
+        value.to_i
+      else
+        raise Supersaas::Exception.new("Invalid id parameter: #{value}. Provide a integer value.")
+      end
+    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.")
+      end
+    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.")
+      end
+    end
+
+    def validate_options(value, options)
+      if options.include?(value)
+        value
+      else
+        raise Supersaas::Exception.new("Invalid option parameter: #{value}. Must be one of #{options.join(', ')}.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+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
+      }
+      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)}
+      res = client.get(path, params)
+      Supersaas::Form.new(res)
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Supersaas
+  class Schedules < BaseApi
+    def list
+      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)}
+      res = client.get(path, query)
+      res.map { |attributes| Supersaas::Resource.new(attributes) }
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+module Supersaas
+  # REF: https://www.supersaas.com/info/dev/user_api
+  class Users < BaseApi
+    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)
+      }
+      res = client.get(path, params)
+      res.map { |attributes| Supersaas::User.new(attributes) }
+    end
+
+    def get(user_id)
+      path = user_path(user_id)
+      res = client.get(path)
+      Supersaas::User.new(res)
+    end
+
+    def create(attributes, user_id=nil, webhook=nil)
+      path = user_path(user_id)
+      query = {webhook: webhook}
+      params = {
+        user: {
+          name: validate_present(attributes[:name]),
+          email: attributes[:email],
+          password: attributes[:password],
+          full_name: attributes[:full_name],
+          address: attributes[:address],
+          mobile: attributes[:mobile],
+          phone: attributes[:phone],
+          country: attributes[:country],
+          field_1: attributes[:field_1],
+          field_2: attributes[:field_2],
+          super_field: attributes[:super_field],
+          credit: attributes[:credit] && validate_number(attributes[:credit]),
+          role: attributes[:role] && validate_options(attributes[:role], User::ROLES)
+        }
+      }
+      client.post(path, params, query)
+    end
+
+    def update(user_id, attributes, webhook=nil)
+      path = user_path(validate_id(user_id))
+      query = {webhook: webhook}
+      params = {
+        user: {
+          name: attributes[:name],
+          email: attributes[:email],
+          password: attributes[:password],
+          full_name: attributes[:full_name],
+          address: attributes[:address],
+          mobile: attributes[:mobile],
+          phone: attributes[:phone],
+          country: attributes[:country],
+          field_1: attributes[:field_1],
+          field_2: attributes[:field_2],
+          super_field: attributes[:super_field],
+          credit: attributes[:credit] && validate_number(attributes[:credit]),
+          role: attributes[:role] && validate_options(attributes[:role], User::ROLES)
+        }
+      }
+      client.put(path, params, query)
+    end
+
+    def delete(user_id)
+      path = user_path(validate_id(user_id))
+      client.delete(path)
+    end
+
+    private
+
+    def user_path(user_id)
+      if user_id.nil? || user_id == ''
+        "/users"
+      else
+        "/users/#{user_id}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,159 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Supersaas
+  class Client
+    class << self
+      attr_accessor :configuration
+
+      def configure
+        self.configuration ||= Configuration.new
+        yield(configuration)
+      end
+
+      def instance
+        Thread.current['SUPER_SAAS_CLIENT'] ||= new(configuration || Configuration.new)
+      end
+
+      def user_agent
+        "SSS/#{VERSION} Ruby/#{RUBY_VERSION} API/#{API_VERSION}"
+      end
+    end
+
+    attr_accessor :account_name, :password, :host, :dry_run, :verbose
+    attr_reader :last_request
+
+    def initialize(configuration=nil)
+      configuration = configuration || Configuration.new
+      @account_name = configuration.account_name
+      @password = configuration.password
+      @host = configuration.host
+      @dry_run = configuration.dry_run
+      @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 get(path, query={})
+      request(:get, path, {}, query)
+    end
+
+    def post(path, params={}, query={})
+      request(:post, path, params, query)
+    end
+
+    def put(path, params={}, query={})
+      request(:put, path, params, query)
+    end
+
+    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 password not configured. Call `Supersaas::Client.configure`.") unless password && password.size
+
+      uri = URI.parse(host)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+
+      params = delete_blank_values params
+      query = delete_blank_values query
+
+      path = "/api#{path}.json"
+      path += "?#{URI.encode_www_form(query)}" if query.keys.size > 0
+
+      case http_method
+      when :get
+        req = Net::HTTP::Get.new(path)
+      when :post
+        req = Net::HTTP::Post.new(path)
+        req.body = params.to_json
+      when :put
+        req = Net::HTTP::Put.new(path)
+        req.body = params.to_json
+      when :delete
+        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.")
+      end
+
+      req.basic_auth account_name, password
+
+      req['Accept'] = 'application/json'
+      req['Content-Type'] = 'application/json'
+      req['User-Agent'] = self.class.user_agent
+
+      if verbose
+        puts "### SuperSaaS Client Request:"
+        puts "#{http_method} #{path}"
+        puts params.to_json
+        puts "------------------------------"
+      end
+
+      @last_request = req
+      return {} if dry_run
+
+      begin
+        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}")
+      end
+
+      if verbose
+        puts "Response:"
+        puts res.body
+        puts "=============================="
+      end
+
+      code = res.code.to_i
+      case code
+      when 200, 201
+        json_body(res)
+      when 422, 400
+        json_body(res)
+      else
+        {}
+      end
+    end
+
+    def json_body(res)
+      begin
+        res.body && res.body.size ? JSON.parse(res.body) : {}
+      rescue JSON::ParserError
+        {}
+      end
+    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))
+        v.nil? || v == ''
+      end
+    end
+
+    class Configuration
+      DEFAULT_HOST = 'https://www.supersaas.com'
+
+      attr_accessor :account_name, :host, :password, :dry_run, :verbose
+
+      def initialize
+        @account_name = ENV['SSS_API_ACCOUNT_NAME']
+        @password = ENV['SSS_API_PASSWORD']
+        @host = DEFAULT_HOST
+        @dry_run = false
+        @verbose = false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Supersaas
+  class Exception < StandardError
+    @field = nil
+    @code = nil
+
+    attr_accessor :field, :code
+  end
+end

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

@@ -0,0 +1,22 @@
+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_reader :form, :slot
+
+    def form=(value)
+      if value.is_a?(Hash)
+        @form = Supersaas::Form.new(value)
+      else
+        @form = value
+      end
+    end
+
+    def slot=(value)
+      if value.is_a?(Hash)
+        @slot = Supersaas::Slot.new(value)
+      else
+        @slot = value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Supersaas
+  class BaseModel
+    attr_accessor :errors
+    attr_reader :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+      assign_attributes(attributes)
+    end
+
+    private
+
+    def assign_attributes(attributes)
+      attributes.each do |key, value|
+        public_send("#{key}=", value) if respond_to?("#{key}=")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+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
+  end
+end

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

@@ -0,0 +1,5 @@
+module Supersaas
+  class Resource < BaseModel
+    attr_accessor :id, :name
+  end
+end

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

@@ -0,0 +1,5 @@
+module Supersaas
+  class Schedule < BaseModel
+    attr_accessor :id, :name
+  end
+end

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

@@ -0,0 +1,14 @@
+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
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Supersaas
+  class User < BaseModel
+    ROLES = [3, 4, -1]
+
+    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
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+module Supersaas
+  API_VERSION  = '1'
+  VERSION = '0.9.0'
+end

data/lib/supersaas-api-client.rb

@@ -0,0 +1 @@
+require_relative './supersaas'

data/lib/supersaas.rb

@@ -0,0 +1,15 @@
+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"

data/supersaas-api-client.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require "supersaas-api-client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "supersaas-api-client"
+  spec.version       = Supersaas::VERSION
+  spec.authors       = ["Travis Dunn"]
+  spec.email         = ["travis@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.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test)/})
+  end
+  spec.test_files    = Dir['test/**/*']
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end