wialon 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c468b5adac754601ead67242a4996a7b1c3af2d95484175bd481fb44618a97eb
-  data.tar.gz: b89f3da4f7817a8677858e70a4a3ef6208c61382edbca7bc2cc2baef2d04c816
+  metadata.gz: 0ed7252fcc81139620337bbf452c2b72c61bb531f9c7ecbd81e3bf8a088a4aae
+  data.tar.gz: e39f71251095a4d557977321bd64ceeace8403eb0681d6883bc7b409a6ac3f84
 SHA512:
-  metadata.gz: 3ab37f8e399efb71ae589c26e63d2c8769a68468f3e461788516c281af39c8ae0a5fa5a5dddae90eddf8d026b5f41eea0d303fff1eb720e3ab74b576b4cb285d
-  data.tar.gz: 93208ff60ea8932d9df111ecd4b8cc10162a9e78669d78effdef090084d0db2877e2d753300ddd2e3bfbece4fe2963d15a50944a59ad8069edf89cb028aa0286
+  metadata.gz: 85d460361e1684dbb4d79f90675957c0c5c43820f67220097448008f5b9bc75b66710569ec96bdedd0154e90810707f4f4f06a3ee4db05f78a2e3fea7d6547cf
+  data.tar.gz: 4b547340fa10108ded011dd09249f5507b8c0ffa0a1b7ec1a368caa99e274ca90d0e8e2e61bc83d95d9529f559e490174b7cf7000543e015ad976b83d154306b

data/lib/wialon.rb

@@ -1,227 +1,209 @@
-class Wialon
-  require 'json'
-  require 'net/http'
-  require 'uri'
-
-  # Variables
-  attr_accessor :sid, :base_api_url, :default_params, :uid, :host, :scheme, :debug
-
-  # Class constructor
-  def initialize(debug = false, scheme = 'https', host = 'hst-api.wialon.com', port = 0, sid = '', extra_params = {})
-    self.debug = debug
-    self.sid = ''
-    self.scheme = scheme
-    self.default_params = {}
-    self.default_params.replace(extra_params)
-    self.host = host
-    self.base_api_url = "#{scheme}://#{host}#{((port > 0) ? ":" + port.to_s : "")}/wialon/ajax.html?"
-    self.uid = ''
-  end
+## WialonSDK class
+module Wialon
+  class Sdk
+    require 'json'
+    require 'net/http'
+    require 'uri'
+
+    attr_accessor :session_id, :base_url, :default_params, :user_id, :host, :is_development
+
+    def initialize(is_development = false, scheme = 'https', host = 'hst-api.wialon.com', port = 0, session_id = '', extra_params = {})
+      self.is_development = is_development
+      self.session_id = session_id
+      self.host = host
+
+      self.default_params = {}
+      self.default_params.replace(extra_params)
+
+      if port < 0
+        raise SdkException.new('Invalid port, must be greater than 0')
+      elsif port.to_i > 0
+        self.base_url = "#{scheme}://#{host}:#{port}"
+      else
+        self.base_url = "#{scheme}://#{host}"
+      end
 
-  def get_address(lat, lon, flags = 1255211008)
-    if self.debug
-      puts "URL: #{'https://geocode-maps.wialon.com/' + self.host + '/gis_geocode?coords=[' + JSON.generate({"lon": lon,"lat": lat}) + ']&flags=' + flags.to_s + '&uid=' + self.uid.to_s}"
+      self.base_url += '/wialon/ajax.html?'
+      self.user_id = 0
     end
-    uri = URI.parse('https://geocode-maps.wialon.com/' + self.host + '/gis_geocode?coords=[' + JSON.generate({"lon": lon,"lat": lat}) + ']&flags=' + flags.to_s + '&uid=' + self.uid.to_s)
-    request = Net::HTTP::Post.new(uri)
-    req_options = { use_ssl: (uri.scheme == "https") }
-    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-      http.request(request)
-    end
-    return JSON.parse(response.body)[0]
-  end
 
-  def get_coordinates(string) 
-    string = string.split(" ").join(" ")
-    from  = "ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž"
-    to = "AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz"
-    string = string.tr(from,to)
-
-    uri = URI.parse('https://search-maps.wialon.com/' + self.host + '/gis_searchintelli?phrase=' + string + '&count=1&indexFrom=0&uid=' + self.uid.to_s)
-    request = Net::HTTP::Post.new(uri)
-    req_options = { use_ssl: (uri.scheme == "https") }
-    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-      http.request(request)
-    end
-    
-    return JSON.parse(response.body) 
-  end 
-
-  def call_without_svc_parse(action, args)
-    # Set local variable with base url
-    url = self.base_api_url
-
-    # Set params
-    params = {'svc': action.to_s, 'params': JSON.generate(args), 'sid': self.sid}
-    
-    # Replacing global params with local params
-    all_params = self.default_params.replace(params)
-
-    if self.debug
-      puts "========="
-      puts "Query URL: #{url} - Params: #{all_params}"
-      puts "========="
-      puts "#{url}&svc=#{action.to_s}&params=#{JSON.generate(args)}&sid=#{self.sid}"
-      puts "========="
-    end
+    def reverse_geocoding(latitude, longitude, flags=1255211008)
+      coordinates = JSON.generates({latitude: latitude, longitude: longitude})
+      url = "https://geocode-maps.wialon.com/#{self.host}/gis_geocode?coords=[#{coordinates}]&flags=#{flags}&uid=#{self.user_id}"
 
-    uri = URI.parse(url)
-    
-    # Curl request
-    request = Net::HTTP::Post.new(uri)
+      if self.is_development
+        self.debug_printer("Method: Reverse geocoding service\nURL: #{url}")
+      end
 
-    request.set_form_data(
-      "svc" => action.to_s,
-      "params" => JSON.generate(args),
-      "sid" => self.sid
-    )
+      begin
+        uri = URI.parse(url)
+      rescue Exception => e
+        raise SdkException.new("Internal error: #{e}")
+      end
 
-    req_options = { use_ssl: (uri.scheme == "https") }
+      request = Net::HTTP::Post.new(uri)
 
-    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-      http.request(request)
-    end
-
-    response = JSON.parse(response.body)
+      begin
+        response = Net::HTTP.start(uri.hostname, uri.port, { use_ssl: uri.scheme == 'https' }) do |http|
+          http.request(request)
+        end
+      rescue Exception => e
+        raise SdkException.new("Internal error: #{e}")
+      end
 
-    return response
-  end
+      begin
+        response = JSON.parse(response.body)
+      rescue Exception => e
+        raise SdkException.new("Internal error: #{e}")
+      end
 
-  # RemoteAPI request performer
-  # action: RemoteAPI command name
-  # args: JSON string with request parameters
-  def call(action, args)
-    # Set local variable with base url
-    url = self.base_api_url
-
-    # Set params
-    params = {'svc': action.to_s.sub('_', '/'), 'params': JSON.generate(args), 'sid': self.sid}
-    
-    # Replacing global params with local params
-    all_params = self.default_params.replace(params)
-
-    if self.debug
-      puts "========="
-      puts "Query URL: #{url} - Params: #{all_params}"
-      puts "========="
-      puts "#{url}&svc=#{action.to_s.sub('_', '/')}&params=#{JSON.generate(args)}&sid=#{self.sid}"
-      puts "========="
+      return response[0]
     end
 
-    uri = URI.parse(url)
-    
-    # Curl request
-    request = Net::HTTP::Post.new(uri)
+    def login(token)
+      result = self.token_login({ token: token })
 
-    request.set_form_data(
-      "svc" => action.to_s.sub('_', '/'),
-      "params" => JSON.generate(args),
-      "sid" => self.sid
-    )
+      self.user_id = result['user']['id']
+      self.session_id = result['eid']
 
-    req_options = { use_ssl: (uri.scheme == "https") }
+      return result
+    end
 
-    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-      http.request(request)
+    def logout
+      self.core_logout
+      return nil
     end
 
-    response = JSON.parse(response.body, symbolize_names: true)
+    def set_session_id(session_id)
+      self.session_id = session_id
+    end
 
-    if response.class == Hash
-      if !response[:error].nil?
-        return {
-          status: 400,
-          reason: parse_errors(response[:error]),
-          result: response
-        }
-      end
+    def get_session_id
+      return self.session_id
     end
 
-    return {
-      status: 200,
-      result: response
-    }
-  end
+    protected
+      def call(method_name, args)
+        svc = ''
+        if method_name.to_s == 'unit_group_update_units'
+          svc = 'unit_group/update_units'
+        else
+          svc = method_name.to_s.sub('_', '/')
+        end
 
-  def login(token)
-    result = self.token_login({token: token})
-    if !result[:result][:eid].nil?
-      self.sid = result[:result][:eid]
-    end
+        begin
+          parameters = JSON.generate(args)
+        rescue Exception => e
+          raise SdkException.new("Internal error: #{e}")
+        end
 
-    begin
-      if !result[:result][:user][:id].nil?
-        self.uid = result[:result][:user][:id]
-      end
-    rescue Exception => e
-      if self.debug
-        puts "Error in login: #{e}"
-      end
-    end
-    return result
-  end
+        parameters = {
+          svc: svc,
+          params: parameters,
+          sid: self.session_id
+        }
 
-  def logout
-    result = self.core_logout({})
-    if result.empty? && result[:result][:error] == 0
-      self.sid = ""
-    end
-    return result
-  end
+        url = "#{self.base_url}svc=#{parameters[:svc]}&params=#{parameters[:params]}&sid=#{parameters[:sid]}"
+        if self.is_development
+          self.debug_printer("Method: #{svc}\nParameters: #{parameters}\nURL: #{url}")
+        end
+
+        begin
+          uri = URI.parse(url)
+        rescue Exception => e
+          raise SdkException.new("Internal error: #{e}")
+        end
+
+        request = Net::HTTP::Post.new(uri)
+        request.set_form_data(
+          'svc' => parameters[:svc],
+          'params' => parameters[:params],
+          'sid' => parameters[:sid]
+        )
+
+        begin
+          response = Net::HTTP.start(uri.hostname, uri.port, { use_ssl: uri.scheme == 'https' }) do |http|
+            http.request(request)
+          end
+        rescue Exception => e
+          raise SdkException.new("Internal error: #{e}")
+        end
+
+        begin
+          response = JSON.parse(response.body)
+        rescue Exception => e
+          raise SdkException.new("Internal error: #{e}")
+        end
+
+        if response.class == Hash
+          if !response['error'].nil?
+            if response['error'] != 0
+              raise Wialon::Error.new(response['error'].to_i, (response['reason'].nil? ? '' : response['reason']))
+            end
+          end
+        end
+
+        return response
+      end
 
-  # Unknonwn methods handler
-  def method_missing(name, *args)
-    if self.debug
-      puts "Query method: #{name}"
-    end
+      def debug_printer(message)
+        puts "*******" * 10
+        puts "#{message}"
+        puts "*******" * 10
+      end
 
-    return self.call(name, ((args.count === 0) ? '{}' : args[0]))
+      def method_missing(method_name, *args)
+        return self.call(method_name, args.count == 0 ? {} : args[0])
+      end
   end
 
-  private 
-    def parse_errors(code)
-      errors = {
-        '1' => "Invalid session",
-        '2' => "Invalid service name",
-        '3' => "Invalid result",
-        '4' => "Invalid input",
-        '5' => "Error performing request",
-        '6' => "Unknown error",
-        '7' => "Access denied",
-        '8' => "Invalid user name or password",
-        '9' => "Authorization server is unavailable",
-        '10' => "Reached limit of concurrent requests",
-        '11' => "Password reset error",
-        '14' => "Billing error",
-        '1001' => "No messages for selected interval",
-        '1002' => "Item with such unique property already exists or Item cannot be created according to billing restrictions",
-        '1003' => "Only one request is allowed at the moment",
-        '1004' => "Limit of messages has been exceeded",
-        '1005' => "Execution time has exceeded the limit",
-        '1006' => "Exceeding the limit of attempts to enter a two-factor authorization code",
-        '1011' => "Your IP has changed or session has expired",
-        '2014' => "Selected user is a creator for some system objects, thus this user cannot be bound to a new account",
-        '2015' => "Sensor deleting is forbidden because of using in another sensor or advanced properties of the unit"
+  class Error < Exception
+    def initialize(code, details = '')
+      _errors = {
+        -1 => 'Unhandled error code',
+        1 => 'Invalid session',
+        2 => 'Invalid service name',
+        3 => 'Invalid result',
+        4 => 'Invalid input',
+        5 => 'Error performing request',
+        6 => 'Unknown error',
+        7 => 'Access denied',
+        8 => 'Invalid user name or password',
+        9 => 'Authorization server is unavailable',
+        10 => 'Reached limit of concurrent requests',
+        11 => 'Password reset error',
+        14 => 'Billing error',
+        1001 => 'No messages for selected interval',
+        1002 => 'Item with such unique property already exists or Item cannot be created according to billing restrictions',
+        1003 => 'Only one request is allowed at the moment',
+        1004 => 'Limit of messages has been exceeded',
+        1005 => 'Execution time has exceeded the limit',
+        1006 => 'Exceeding the limit of attempts to enter a two-factor authorization code',
+        1011 => 'Your IP has changed or session has expired',
+        2014 => 'Selected user is a creator for some system objects, thus this user cannot be bound to a new account',
+        2015 => 'Sensor deleting is forbidden because of using in another sensor or advanced properties of the unit'
       }
 
-      if errors[code.to_s].nil?
-        return "Unknown error"
+      @message = ''
+      if _errors[code].nil?
+        @message = "#{_errors[-1]}"
       else
-        return errors[code.to_s]
+        @message = "#{_errors[code]}"
       end
-    end
-    # SID setter
-    def set_sid(sid)
-      self.sid = sid
-    end
 
-    # SID getter
-    def get_sid
-      return self.sid
-    end
+      if details.length > 0
+        @message += " - #{details}"
+      end
 
-    # Update extra parameters
-    def update_extra_params(params)
-      self.default_params.replace(params)
+      @code = code
+      super("WialonError(code: #{@code}, reason: #{@message})")
     end
+  end
+end
+
+class SdkException < Exception
+  def initialize(message = '')
+    @message = message
+    super("SdkException(#{@message})")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wialon
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Golden M Software