mitake 0.1.2

data/lib/mitake/api/base.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'mitake/credential'
+
+module Mitake
+  module API
+    # @since 0.1.0
+    # @api private
+    class Base
+      # @param path [String] the api endpoint
+      # @param params [Hash] the request body
+      #
+      # @since 0.1.0
+      # @api private
+      def initialize(path, params = {})
+        @path = path
+        @params = params
+      end
+
+      # @since 0.1.0
+      # @api private
+      def request
+        raise NotImplementedError, 'Request not defined!'
+      end
+
+      # Execute HTTP Request
+      #
+      # @return [Net::HTTPResponse] the request result
+      #
+      # @since 0.1.0
+      # @api private
+      def execute
+        Net::HTTP.start(uri.host, uri.port, use_ssl: ssl?) do |http|
+          http.request request
+        end
+      end
+
+      # @return [URI] the request URI
+      #
+      # @since 0.1.0
+      # @api private
+      def uri
+        @uri ||= URI("#{Mitake.credential.server}#{@path}")
+      end
+
+      # @return [TrueClass|FalseClass] is the SSL request
+      #
+      # @since 0.1.0
+      # @api private
+      def ssl?
+        @uri.scheme == 'https'
+      end
+
+      # Return the request params
+      #
+      # @return [Hash] the query params
+      #
+      # @since 0.1.0
+      # @api private
+      def params
+        @params.merge(
+          username: Mitake.credential.username,
+          password: Mitake.credential.password
+        )
+      end
+    end
+  end
+end

data/lib/mitake/api/get.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'mitake/api/base'
+
+module Mitake
+  module API
+    # Create HTTP Get Request
+    #
+    # @since 0.1.0
+    # @api private
+    class Get < Base
+      # Create HTTP Get Request
+      #
+      # @since 0.1.0
+      # @api private
+      def request
+        return @request unless @request.nil?
+
+        @request ||= Net::HTTP::Get.new(uri)
+      end
+
+      # @see Mitake::API::Base#uri
+      #
+      # @since 0.1.0
+      # @api private
+      def uri
+        @uri ||=
+          URI("#{Mitake.credential.server}" \
+              "#{@path}?#{URI.encode_www_form(params)}")
+      end
+    end
+  end
+end

data/lib/mitake/api/post.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'mitake/api/base'
+
+module Mitake
+  module API
+    # Create HTTP Get Request
+    #
+    # @since 0.1.0
+    # @api private
+    class Post < Base
+      # Create HTTP Post Request
+      #
+      # @since 0.1.0
+      # @api private
+      def request
+        return @request unless @request.nil?
+
+        @request ||= Net::HTTP::Post.new(uri)
+        @request.body = URI.encode_www_form(params)
+        @request
+      end
+    end
+  end
+end

data/lib/mitake/balance.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'mitake/api'
+require 'mitake/model'
+
+module Mitake
+  # Get the current balance
+  #
+  # @since 0.1.0
+  class Balance
+    class << self
+      # Get account point
+      #
+      # @see Mitake::Balance#amount
+      # @return [Integer]
+      #
+      # @since 0.1.0
+      def amount
+        execute&.first&.amount
+      end
+    end
+
+    include API
+    include Model
+
+    path '/api/mtk/SmQuery'
+    map 'AccountPoint', 'amount'
+
+    # @!attribute [r] amount
+    # @return [Integer] the amount of account point
+    #
+    # @since 0.1.0
+    attribute :amount, Integer
+  end
+end

data/lib/mitake/boolean.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mitake
+  # The helper object to define boolean value
+  #
+  # @since 0.1.0
+  # @api private
+  class Boolean
+    TRUE_VALUES = %w[Y 1 yes true].freeze
+
+    class << self
+      # Parse boolean value
+      #
+      # @since 0.1.0
+      # @api private
+      def parse(value)
+        return true if value == true
+        return true if TRUE_VALUES.include?(value)
+
+        false
+      end
+    end
+  end
+end

data/lib/mitake/credential.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mitake
+  # The Mitake SMS Client
+  #
+  # @since 0.1.
+  class Credential
+    # @since 0.1.0
+    # @api private
+    DEFAULT_SERVER = 'https://smsapi.mitake.com.tw'
+
+    # @since 0.1.0
+    attr_reader :username, :password, :server
+
+    # Return Mitake::Client instance
+    #
+    # @param username [String] the username, default is `MITAKE_USERNAME`
+    # @param password [String] the password, default is `MITAKE_PASSWORD`
+    # @param server [String] the API server url
+    # @return [Mitake::Client] the api instance
+    #
+    # @since 0.1.0
+    def initialize(username = nil, password = nil, server = nil)
+      @username = username || ENV['MITAKE_USERNAME']
+      @password = password || ENV['MITAKE_PASSWORD']
+      @server = server || ENV['MITAKE_SERVER'] || DEFAULT_SERVER
+    end
+  end
+end

data/lib/mitake/message.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'mitake/model'
+require 'mitake/recipient'
+require 'mitake/response'
+require 'mitake/boolean'
+require 'mitake/status'
+
+module Mitake
+  # Create Sort Message
+  #
+  # @since 0.1.0
+  class Message
+    include API
+    include Model
+
+    method 'Post'
+    path '/api/mtk/SmSend?CharsetURL=UTF8'
+    map 'msgid', 'id'
+    map 'Duplicate', 'duplicate'
+    map 'statuscode', 'status_code'
+
+    # @!attribute [r] id
+    # @return [String] the message id
+    attribute :id, String, readonly: true
+
+    # @!attribute source_id
+    # @return [String] the customize identity
+    attribute :source_id, String
+
+    # @!attribute receipient
+    # @return [Mitake::Recipient] the message recipient
+    attribute :recipient, Recipient
+
+    # @!attribute body
+    # @return [String] the message body
+    attribute :body, String
+
+    # @!attribute schedule_at
+    # @return [Time|NilClass] the schedule time to send message
+    attribute :schedule_at, Time
+
+    # @!attribute expired_at
+    # @return [Time|NilClass] the valid time for this message
+    attribute :expired_at, Time
+
+    # @!attribute webhook_url
+    # @return [String|NilClass] the response callback url
+    attribute :webhook_url, String
+
+    # @!attribute [r] duplicate
+    # @return [TrueClass|FalseClass] is the message duplicate
+    attribute :duplicate, Boolean, readonly: true
+
+    # @!attribute [r] status_code
+    # @return [Integer] the status code
+    attribute :status_code, Integer, readonly: true
+
+    # Send message
+    #
+    # @since 0.1.0
+    # @api private
+    def delivery
+      return self if sent?
+
+      self.class.execute(params) do |items|
+        attrs = items&.first&.slice(*self.class.attribute_names)
+        assign_attributes(attrs)
+      end
+
+      self
+    end
+
+    # Does message is sent
+    #
+    # @return [TrueClass|FalseClass] is the message sent
+    #
+    # @since 0.1.0
+    def sent?
+      !@id.nil?
+    end
+
+    # Does message is duplicate
+    #
+    # @return [TrueClass|FalseClass] is the message duplicate
+    #
+    # @since 0.1.0
+    def duplicate?
+      @duplicate == true
+    end
+
+    # Readable status code
+    #
+    # @return [String] the status code description
+    #
+    # @since 0.1.0
+    def status
+      Status::CODES[@status_code]
+    end
+
+    private
+
+    # The request params
+    #
+    # @since 0.1.0
+    # @api private
+    def params
+      {
+        clientid: @source_id,
+        smbody: @body,
+        dlvtime: @schedule_at&.strftime('%Y%m%d%H%M%S'),
+        vldtime: @expired_at&.strftime('%Y%m%d%H%M%S'),
+        dstaddr: @recipient.phone_number,
+        destname: @recipient.name,
+        response: @webhook_url
+      }.reject { |_, v| v.nil? }.to_h
+    end
+  end
+end

data/lib/mitake/model.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'mitake/model/attributes'
+require 'mitake/model/accessor'
+
+module Mitake
+  # Provide attributes accessor
+  #
+  # @since 0.1.0
+  # @api private
+  module Model
+    # @since 0.1.0
+    # @api private
+    def self.included(base)
+      base.class_eval do
+        include Attributes
+        extend Accessor
+      end
+    end
+
+    # Get attributes as hash
+    #
+    # @return [Hash] the object attributes
+    #
+    # @since 0.1.0
+    def attributes
+      self
+        .class
+        .attribute_names
+        .map { |attr| [attr, send(attr)] }
+        .reject { |_, value| value.nil? }
+        .map do |attr, value|
+        [attr, value.respond_to?(:attributes) ? value.attributes : value]
+      end
+        .to_h
+    end
+  end
+end

data/lib/mitake/model/accessor.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'date'
+
+module Mitake
+  module Model
+    # @since 0.1.0
+    # @api private
+    module Accessor
+      # Get attributes
+      #
+      # @return [Hash] the list of attributes and type
+      #
+      # @since 0.1.0
+      def attributes
+        @attributes ||= {}
+      end
+
+      # Get attribute names
+      #
+      # @return [Array] the list of attribute names
+      #
+      # @since 0.1.0
+      def attribute_names
+        attributes.keys
+      end
+
+      # Define attribute
+      #
+      # @param name [String|Symbol] the attribute name
+      # @param type [Class] the attribute type
+      # @param readonly [TrueClass|FalseClass] is attribute readonly
+      #
+      # @since 0.1.0
+      def attribute(name, type = 'String', readonly: false)
+        @attributes ||= {}
+        @attributes[name.to_s] = type.to_s
+
+        define_method name do
+          instance_variable_get("@#{name}")
+        end
+        return if readonly
+
+        define_method "#{name}=" do |value|
+          instance_variable_set("@#{name}", self.class.cast(value, type.to_s))
+        end
+      end
+
+      # Casting type
+      #
+      # @param value [Object] the source value
+      # @param type [Class] the cast type
+      #
+      # @since 0.1.0
+      # @api private
+      def cast(value, type = 'String')
+        case type.to_s
+        when 'String', 'Integer', 'Float'
+          Kernel.method(type).call(value)
+        when 'Time', 'DateTime', 'Date'
+          Kernel.const_get(type).parse("#{value}+8")
+        else
+          klass = Kernel.const_get(type)
+          return klass.parse(value) if klass.respond_to?(:parse)
+
+          value
+        end
+      end
+    end
+  end
+end