sms_jatis

README

sms-jatis

This is SMS Jatis Library. It is written in Go to integrate with the SMS Jatis platform.

How to Test

To run the integration tests, we need to do the following:

1. Make a new copy of .env.example to .env by running this command below:

cat .env.example > .env

1. Fill the new .env with the parameter that we already prepared.
2. Run the tests by running this command:

go test -v -race -tags=integration -covermode=atomic ./...

Documentation

Index

• Constants
• Variables
• type ChannelType
• type Client
  • func NewClient(opts ...FnOption) (c Client)
• type FnOption
  • func WithBaseURL(baseURL string) FnOption
  • func WithChannel(channel ChannelType) FnOption
  • func WithClient(client heimdall.Doer) FnOption
  • func WithCustomIPs(customIPs ...string) FnOption
  • func WithDivision(division string) FnOption
  • func WithHystrixOptions(options ...hystrix.Option) FnOption
  • func WithPassword(password string) FnOption
  • func WithSender(sender string) FnOption
  • func WithTimeout(timeout time.Duration) FnOption
  • func WithUploadBy(uploadBy string) FnOption
  • func WithUserID(userID string) FnOption
• type Option
  • func (o *Option) Assign(opts ...FnOption) *Option
  • func (o *Option) Clone() *Option
  • func (o *Option) Default() *Option
• type RequestMessage
  • func (r *RequestMessage) Default(o *Option) *RequestMessage
• type ResponseMessage
  • func (r *ResponseMessage) Error() string
• type StatusParam
  • func (s StatusParam) String() string
  • func (s StatusParam) Uint64String() string
• type UnknownError
  • func (e UnknownError) Error() string

Constants

const (
	FormKeyUserID    = "userid"
	FormKeyPassword  = "password"
	FormKeySender    = "sender"
	FormKeyMSISDN    = "msisdn"
	FormKeyMessage   = "message"
	FormKeyDivision  = "division"
	FormKeyBatchName = "batchname"
	FormKeyUploadBy  = "uploadby"
	FormKeyChannel   = "channel"
)

List of form keys used for request in Jatis.

const (
	// DefaultBaseURL is the default base URL for the Jatis API.
	DefaultBaseURL = "https://sms-api.jatismobile.com/index.ashx"
	// DefaultTimeout is the default timeout for the Jatis API.
	DefaultTimeout = 30 * time.Second
)

const (
	// DefaultBatchOTP is the default batch name for OTP.
	DefaultBatchOTP = "otp"
	// DefaultBaseDecimal is the default base 10 for decimal.
	DefaultBaseDecimal = 10
)

const (
	KeyURLDecodedStatus    = "Status"
	KeyURLDecodedMessageID = "MessageId"
)

List of key used to access the value of URL decoded values.

Variables

var ErrNilArgs = errors.New("nil arguments")

ErrNilArgs is returned when the argument is nil.

Types

type ChannelType

type ChannelType uint64

ChannelType specifies the channel type used in this package.

const (
	ChannelRegular ChannelType = iota
	ChannelAlert
	ChannelOTP
)

List of channel used in Jatis.

type Client

type Client interface {
	// SendSMS sends message to the Jatis platform.
	SendSMS(ctx context.Context, request *RequestMessage) (respBody *ResponseMessage, err error)
}

Client is the interface of Jatis SMS client.

func NewClient

func NewClient(opts ...FnOption) (c Client)

NewClient initializes a new client with the given option.

type FnOption

type FnOption func(o *Option)

FnOption is a function that modifies Option.

func WithBaseURL

func WithBaseURL(baseURL string) FnOption

WithBaseURL sets the base URL for the Jatis API.

func WithChannel

func WithChannel(channel ChannelType) FnOption

WithChannel sets the channel for the Jatis API.

func WithClient

func WithClient(client heimdall.Doer) FnOption

WithClient sets the client for the Jatis API.

func WithCustomIPs

func WithCustomIPs(customIPs ...string) FnOption

WithCustomIPs sets the custom IPs for the Jatis API.

func WithDivision

func WithDivision(division string) FnOption

WithDivision sets the division for the Jatis API.

func WithHystrixOptions

func WithHystrixOptions(options ...hystrix.Option) FnOption

WithHystrixOptions sets the hystrix options for the Jatis API.

func WithPassword

func WithPassword(password string) FnOption

WithPassword sets the password for the Jatis API.

func WithSender

func WithSender(sender string) FnOption

WithSender sets the sender for the Jatis API.

func WithTimeout

func WithTimeout(timeout time.Duration) FnOption

WithTimeout sets the timeout for the Jatis API.

func WithUploadBy

func WithUploadBy(uploadBy string) FnOption

WithUploadBy sets the upload by for the Jatis API.

func WithUserID

func WithUserID(userID string) FnOption

WithUserID sets the user ID for the Jatis API.

type Option

type Option struct {
	BaseURL        string
	UserID         string
	Password       string
	Sender         string
	Division       string
	UploadBy       string
	Channel        *ChannelType
	CustomIPs      []string
	Timeout        time.Duration
	Client         heimdall.Doer
	HystrixOptions []hystrix.Option
	// contains filtered or unexported fields
}

Option is a struct containing all configurations for Jatis.

func (*Option) Assign

func (o *Option) Assign(opts ...FnOption) *Option

Assign assigns the Option to the given FnOption.

func (*Option) Clone

func (o *Option) Clone() *Option

Clone returns a shallow clone of the Option.

func (*Option) Default

func (o *Option) Default() *Option

Default returns a default Option.

type RequestMessage

type RequestMessage struct {
	PhoneNumber string
	Text        string
	BatchName   string
	Channel     *ChannelType
}

RequestMessage defines the request message to Jatis.

func (*RequestMessage) Default

func (r *RequestMessage) Default(o *Option) *RequestMessage

Default returns the default request message for Jatis.

type ResponseMessage

type ResponseMessage struct {
	MessageID    string
	Status       string
	StatusNumber StatusParam
}

ResponseMessage defines the response message from Jatis.

func (*ResponseMessage) Error

func (r *ResponseMessage) Error() string

ResponseMessage implements the error interface.

type StatusParam

type StatusParam uint64

StatusParam is the status parameter in the response message.

const (
	StatusSuccess StatusParam = iota + 1
	StatusMissingParameter
	StatusInvalidUserIDOrPassword
	StatusInvalidMessage
	StatusInvalidMSISDN
	StatusInvalidSender
	StatusDeniedIPAddress
	StatusInternalServerError
	StatusInvalidDivision
)

List of all status parameters used in Jatis.

const (
	StatusInvalidChannel StatusParam = iota + 20
	StatusTokenNotEnough
	StatusTokenNotAvailable
)

List of all status parameters used in Jatis.

func (StatusParam) String

func (s StatusParam) String() string

String returns the string representation of the status param.

func (StatusParam) Uint64String

func (s StatusParam) Uint64String() string

Uint64String converts the uint64 to the string version.

type UnknownError

type UnknownError struct {
	StatusCode int    `json:"status_code"`
	Message    []byte `json:"message"`
}

UnknownError is an error that is not defined by the documentation from the SMS Jatis.

func (UnknownError) Error

func (e UnknownError) Error() string

Error implements the error interface.