ileti_merkezi 0.1.0

data/lib/ileti_merkezi/authentication.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  # Authentication
+  module Authentication
+    module_function
+
+    def content
+      send(IletiMerkezi.configuration.auth_method)
+    end
+
+    def auth_basic
+      config = IletiMerkezi.configuration
+      <<-XML.gsub(/^[ ]+/, '').strip
+      <authentication>
+        <username>#{config.username}</username>
+        <password>#{config.password}</password>
+      </authentication>
+      XML
+    end
+
+    def auth_token
+      config = IletiMerkezi.configuration
+      <<-XML.gsub(/^[ ]+/, '').strip
+      <authentication>
+        <key>#{config.public_key}</key>
+        <hash>#{config.hmac}</hash>
+      </authentication>
+      XML
+    end
+  end
+end

data/lib/ileti_merkezi/balance.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  # Balance
+  module Balance
+    PATH = '/get-balance'.freeze
+
+    module_function
+
+    def query
+      request = Request.new(path: PATH)
+      request.call
+    end
+  end
+end

data/lib/ileti_merkezi/cancel.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  # Cancel
+  class Cancel
+    PATH = '/cancel-order'.freeze
+
+    attr_reader :order_id
+
+    def initialize(order_id)
+      @order_id = order_id
+    end
+
+    def confirm
+      request = Request.new(content: content, path: PATH)
+      request.call
+    end
+
+    private
+
+    def content
+      "<id>#{order_id}</id>"
+    end
+  end
+end

data/lib/ileti_merkezi/configuration.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module IletiMerkezi
+  # Configuration
+  # :reek:TooManyInstanceVariables { max_instance_variables: 8 }
+  class Configuration < Module
+    # :reek:Attribute
+    attr_accessor :endpoint,
+                  :username,
+                  :password,
+                  :sender,
+                  :public_key,
+                  :secret_key,
+                  :request_overrides
+
+    ENDPOINT = 'http://api.iletimerkezi.com/v1'.freeze
+    SENDER   = 'ILETI MRKZI'.freeze
+
+    def initialize
+      @endpoint          = ENV['IM_ENDPOINT'] || ENDPOINT
+      @username          = ENV['IM_USERNAME']
+      @password          = ENV['IM_PASSWORD']
+      @public_key        = ENV['IM_PUBLIC_KEY']
+      @secret_key        = ENV['IM_SECRET_KEY']
+      @sender            = ENV['IM_SENDER'] || SENDER
+      @request_overrides = {}
+    end
+
+    def auth_method
+      if public_key && secret_key
+        :auth_token
+      elsif username && password
+        :auth_basic
+      else
+        raise CredentialMissingError, 'Credentials missing'
+      end
+    end
+
+    def hmac
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new('sha256'), secret_key.to_s, public_key.to_s
+      )
+    end
+
+    # set default config
+    def default_config
+      self.username   = ENV['IM_USERNAME']
+      self.password   = ENV['IM_PASSWORD']
+      self.public_key = ENV['IM_PUBLIC_KEY']
+      self.secret_key = ENV['IM_SECRET_KEY']
+      true
+    end
+
+    # config resets
+    def reset
+      self.username   = nil
+      self.password   = nil
+      self.public_key = nil
+      self.secret_key = nil
+      true
+    end
+  end
+end

data/lib/ileti_merkezi/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  class CredentialMissingError < StandardError; end
+  class InvalidMessageError < StandardError; end
+end

data/lib/ileti_merkezi/message.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  # Message
+  class Message
+    attr_reader :phones, :text
+
+    def initialize(phones, text)
+      @phones = phones.is_a?(Array) ? phones : [phones]
+      @text   = text.to_s
+    end
+
+    def content
+      raise InvalidMessageError, to_s unless valid?
+      <<-XML.gsub(/^[ ]+/, '').strip
+      <message>
+        <text>#{text}</text>
+        <receipents>
+          #{phones.compact.map { |phone| phone_xmlify(phone) }.join("\n")}
+        </receipents>
+      </message>
+      XML
+    end
+
+    def summary
+      {
+        text: text,
+        phones: phones,
+        receipents_count: phones.count,
+        valid: valid?
+      }
+    end
+
+    def to_s
+      "Text: #{text}, Phones: #{phones}"
+    end
+
+    def valid?
+      phones.any? && !text.empty?
+    end
+
+    private
+
+    def phone_xmlify(phone)
+      "<number>#{phone.to_s.tr(' ', '')}</number>" unless phone.to_s.empty?
+    end
+  end
+end

data/lib/ileti_merkezi/report.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  # Report
+  class Report
+    PATH = '/get-report'.freeze
+
+    attr_reader :order_id, :page, :row_count
+
+    def initialize(order_id, page: 1, row_count: 1000)
+      @order_id  = order_id
+      @page      = page
+      @row_count = row_count
+    end
+
+    def query
+      request = Request.new(content: content, path: PATH)
+      request.call
+    end
+
+    private
+
+    def content
+      <<-XML.gsub(/^[ ]+/, '').strip
+      <id>#{order_id}</id>
+      <page>#{page}</page>
+      <rowCount>#{row_count}</rowCount>
+      XML
+    end
+  end
+end

data/lib/ileti_merkezi/request.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  # Request
+  # :reek:TooManyInstanceVariables { max_instance_variables: 6 }
+  class Request
+    DEFAULT_OPTIONS = {
+      use_ssl: false,
+      verify_mode: OpenSSL::SSL::VERIFY_PEER,
+      read_timeout: 30,
+      open_timeout: 30
+    }.freeze
+
+    DEFAULT_HEADERS = {
+      'accept' => 'xml',
+      'content-type' => 'text/xml;charset=utf-8'
+    }.freeze
+
+    private_constant :DEFAULT_OPTIONS
+    private_constant :DEFAULT_HEADERS
+
+    # :reek:Attribute
+    attr_writer :uri
+
+    def initialize(body: nil, content: '', path: '')
+      @config  = IletiMerkezi.configuration
+      @content = content
+      @path    = path
+      @body    = body
+      @uri     = URI.parse(@config.endpoint + @path)
+    end
+
+    def call
+      req      = Net::HTTP::Post.new(@uri.request_uri, DEFAULT_HEADERS)
+      req.body = @body || body
+      Response.new http.request(req)
+    end
+
+    private
+
+    attr_reader :config, :uri, :content
+
+    def create_order
+      <<-XML.gsub(/^[ ]+/, '').strip
+      <order>
+        #{content}
+      </order>
+      XML
+    end
+
+    def body
+      <<-XML.gsub(/^[ ]+/, '').strip
+      <?xml version="1.0" encoding="UTF-8" ?>
+      <request>
+        #{Authentication.content}
+        #{create_order}
+      </request>
+      XML
+    end
+
+    def http
+      options = DEFAULT_OPTIONS.merge(config.request_overrides)
+      http    = Net::HTTP.new(
+        uri.hostname, (options[:use_ssl] ? 443 : @uri.port)
+      )
+      http_configure(http, options)
+    end
+
+    def http_configure(http, options)
+      options.each do |option, value|
+        setter = "#{option.to_sym}="
+        http.send(setter, value) if http.respond_to?(setter)
+      end
+      http
+    end
+  end
+end

data/lib/ileti_merkezi/response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module IletiMerkezi
+  # Response
+  class Response
+    extend Forwardable
+
+    def_delegators :status, :message, :error?, :info?, :success?
+
+    attr_reader :response, :code, :body
+
+    def initialize(response)
+      @response = response
+      @code     = response.code.to_i
+      @body     = response.body
+    end
+
+    def status
+      Status.find(code)
+    end
+
+    def to_h
+      hash = Ox.load(
+        body.force_encoding('utf-8'),
+        mode: :hash
+      )
+      hash.fetch(:response, hash)
+    rescue Ox::ParseError
+      {}
+    end
+
+    alias to_hash to_h
+  end
+end

data/lib/ileti_merkezi/sms.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  # Sms
+  class Sms
+    attr_reader :args, :sender
+
+    PATH = '/send-sms'.freeze
+
+    def initialize(args)
+      @args   = args
+      @sender = args[:sender] || IletiMerkezi.configuration.sender
+    end
+
+    def messages
+      messages = args.fetch(:messages, [args])
+      messages.map { |msg| Message.new(msg[:phones], msg[:text]) }
+    end
+
+    def send_datetime
+      args.fetch(:send_datetime, Time.now.strftime('%d/%m/%Y %H:%M'))
+    end
+
+    def send
+      request = Request.new(content: content, path: PATH)
+      request.call
+    end
+
+    private
+
+    def content
+      <<-XML.gsub(/^[ ]+/, '').strip
+      <sender>#{sender}</sender>
+      <sendDateTime>#{send_datetime}</sendDateTime>
+      #{messages.map(&:content).join}
+      XML
+    end
+  end
+end

data/lib/ileti_merkezi/status.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  # Status
+  class Status
+    CODES = {
+      110 => { type: :info, message: 'Mesaj gönderiliyor' },
+      111 => { type: :info, message: 'Mesaj gönderildi' },
+      112 => { type: :error, message: 'Mesaj gönderilemedi' },
+      113 => { type: :info, message: 'Siparişin gönderimi devam ediyor' },
+      114 => { type: :info, message: 'Siparişin gönderimi tamamlandı' },
+      115 => { type: :info, message: 'Sipariş gönderilemedi' },
+      200 => { type: :info, message: 'İşlem başarılı' },
+      400 => { type: :error, message: 'İstek çözümlenemedi' },
+      401 => { type: :error, message: 'Üyelik bilgileri hatalı' },
+      402 => { type: :error, message: 'Bakiye yetersiz' },
+      404 => { type: :error, message: 'API istek yapılan yönteme sahip değil' },
+      450 => { type: :error, message: 'Gönderilen başlık kullanıma uygun değil' },
+      451 => { type: :error, message: 'Tekrar eden sipariş' },
+      452 => { type: :error, message: 'Mesaj alıcıları hatalı' },
+      453 => { type: :error, message: 'Sipariş boyutu aşıldı' },
+      454 => { type: :error, message: 'Mesaj metni boş' },
+      455 => { type: :error, message: 'Sipariş bulunamadı' },
+      456 => { type: :info, message: 'Sipariş gönderim tarihi henüz gelmedi' },
+      457 => { type: :error, message: 'Mesaj gönderim tarihinin formatı hatalı' },
+      503 => { type: :error, message: 'Sunucu geçici olarak servis dışı' }
+    }.freeze
+
+    attr_reader :code, :type, :message
+
+    def initialize(options = {})
+      @code    = options[:code].to_i
+      @type    = options[:type]
+      @message = options[:message]
+    end
+
+    def self.find(code)
+      value = CODES[code.to_i] || {}
+      new(value.merge(code: code))
+    end
+
+    def error?
+      type == :error
+    end
+
+    def info?
+      type == :info
+    end
+
+    def success?
+      info?
+    end
+  end
+end

data/lib/ileti_merkezi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  VERSION = '0.1.0'.freeze
+end

data/lib/ileti_merkezi.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'ox'
+
+files = %w[
+  version
+  error
+  configuration
+  account
+  authentication
+  balance
+  cancel
+  message
+  request
+  report
+  response
+  sms
+  status
+]
+
+files.each { |path| require_relative "./ileti_merkezi/#{path}" }
+
+# IletiMerkezi
+module IletiMerkezi
+  class << self
+    # :reek:Attribute
+    attr_writer :configuration
+  end
+
+  module_function
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    yield(configuration)
+  end
+
+  # Helper Methods
+
+  # Get balance information
+  #
+  # @return [IletiMerkezi::Response]
+  #
+  # @api public
+  def balance
+    Balance.query
+  end
+
+  # Sms order cancellation
+  #
+  # @param order_id [Integer] Sms order id
+  #
+  # @return [IletiMerkezi::Response]
+  #
+  # @api public
+  def cancel(order_id)
+    Cancel.new(order_id).confirm
+  end
+
+  # Find status with code id
+  #
+  # @param code_id [Integer] Http status code
+  #
+  # @return [IletiMerkezi::Status]
+  #
+  # @api public
+  def code(code_id)
+    Status.find(code_id)
+  end
+
+  # Get account information
+  #
+  # @return [Hash]
+  # {
+  #   name_surname: 'name-surname',
+  #   tc_number: nil,
+  #   title: nil,
+  #   email: 'email',
+  #   gsm: 'phone',
+  #   password: 'password',
+  #   commercial_title: nil,
+  #   gsm2: nil,
+  #   phone_number: nil,
+  #   fax_number: nil,
+  #   bill_address: nil,
+  #   zone: nil,
+  #   city: nil,
+  #   zip: nil,
+  #   charge_home: nil,
+  #   charge_number: nil
+  # }
+  #
+  # @api public
+  def info
+    response = Account.info
+    response.to_h.fetch(:userInfo, {})
+  end
+
+  # Get Sms order report
+  #
+  # @param order_id [Integer], page [Integer], row_count [Integer]
+  #
+  # @return [IletiMerkezi::Response]
+  #
+  # @api public
+  def report(order_id, page: 1, row_count: 1000)
+    Report.new(order_id,
+               page: page,
+               row_count: row_count).query
+  end
+
+  # Sms send method
+  #
+  # @param args [Hash]
+  #
+  # @return [IletiMerkezi::Response]
+  #
+  # Example:
+  #
+  # args1 = {
+  #   send_datetime: '15/01/2017 12:00' # Opsiyonel
+  #   sender: 'TEST' # Opsiyonel
+  #   phones: ['0555 555 00 01', '0555 555 00 02']
+  #   text: 'Test Message'
+  # }
+  #
+  # args2 = {
+  #   send_datetime: '15/01/2017 12:00' # Opsiyonel
+  #   sender: 'TEST' # Opsiyonel
+  #   messages: [
+  #     {
+  #       text: 'First Test Message',
+  #       phones: ['0555 555 00 01', '0555 555 00 02'],
+  #     },
+  #     {
+  #       text: 'Second Test Message',
+  #       phones: ['0555 555 00 03', '0555 555 00 04'],
+  #     }
+  #   ]
+  # }
+  #
+  # response = IletiMerkezi.send(args1)
+  # or
+  # response = IletiMerkezi.send(args2)
+  #
+  # @api public
+  def send(args)
+    Sms.new(args).send
+  end
+
+  # Get senders
+  #
+  # @return [Hash]
+  #
+  # @api public
+  def senders
+    response = Account.senders
+    response.to_h.fetch(:smsHeaderInfo, {})
+  end
+
+  # Get Service Status
+  #
+  # @return [Boolean]
+  #
+  # @api public
+  def status
+    balance.code == 200
+  end
+end