wialon_api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3696f2c16f7126835bd10c13a5f533b72b07a00
-  data.tar.gz: 84af7147d2315e1d17c3b4ce349c7383aa90d5b7
+  metadata.gz: 837b4373fd4679f2e4ff1836a4a0e5539a13e938
+  data.tar.gz: 2546fbb21ba7c2485bcec73cafebcccbff59e742
 SHA512:
-  metadata.gz: f11002df1f7a104c1427c03ee96367e3951b89a82a1595f7ed99ecc8f04bd016cc296de8644c39b769475598d9d608d3b954281e0f8c491d1ee8a0064a44fc81
-  data.tar.gz: f71918769c4d9e04f5453133bad5d2c7f8bfda94a1c16b125c9f9e03b49f775f470bffa08d88e33ebb314f79a19b689877cac6169cd65569d98d87b636b995a3
+  metadata.gz: 0428f8f6cff58ff21817135e088a0270bbeec42c153f956fd99526c1d6bab64337a1c94e0b77d46c74556a8b5daad2fcaceb380b9251244ecfbc9b6c2aa5b4c2
+  data.tar.gz: b599c28dd28a925035335516c51cd28d5f6ff0aac93de75c224cb6ac210571137dbd20b7818bfda5bd550c400732ee85d253e3474ae3f57f38d87851ceebd64f

data/README.md

@@ -143,9 +143,14 @@ WialonApi.configure do |config|
 
   # Wialon server host
   # config.wialon_host = 'https://hst-api.wialon.com/wialon/ajax.html'
+
+  # Wialon server edition: :hosting, :local, :pro
+  # config.wialon_edition = :hosting
 end
 ```
 
+Note that `Wialon Pro` edition uses different parameters in requests, e.g. `ssid` vs `eid` as the session identifier. `WialonApi` gem handles these differences automatically.
+
 `Net::HTTP` is used by default for a HTTP requests. One can choose any [other adapter](https://github.com/technoweenie/faraday/blob/master/lib/faraday/adapter.rb) suported by `faraday`.
 
 Options for faraday connection (e.g. proxy settings or SSL certificates path) could be set through `faraday_options` when configuring `wialon_api`

data/lib/generators/wialon_api/install/templates/initializer.rb

@@ -27,4 +27,7 @@ WialonApi.configure do |config|
 
   # Wialon server host
   # config.wialon_host = 'https://hst-api.wialon.com/wialon/ajax.html'
+
+  # Wialon server edition: :hosting, :local, :pro
+  # config.wialon_edition = :hosting
 end

data/lib/wialon_api/api.rb

@@ -3,7 +3,7 @@ require 'json'
 module WialonApi
   module Api
     def self.call(service_name, args = {}, sid = nil)
-      parameters = { svc: service_name, params: args.to_json, ssid: sid }
+      parameters = { svc: service_name, params: args.to_json, WialonApi.wialon_session_identifier => sid }
       connection(url: WialonApi.wialon_host).send(WialonApi.http_verb, nil, parameters).body
     end
 

data/lib/wialon_api/authorization.rb

@@ -3,11 +3,7 @@ module WialonApi
     def authorize(user, password)
       response = WialonApi::Api.call('core/login', user: user, password: password)
       result = WialonApi::Result.process(response)
-      if WialonApi.wialon_edition == :pro
-        WialonApi::Client.new(result.ssid)
-      else
-        WialonApi::Client.new(result.eid)
-      end
+      WialonApi::Client.new(result.send(WialonApi.wialon_client_session_identifier))
     end
   end
 end

data/lib/wialon_api/configuration.rb

@@ -17,12 +17,21 @@ module WialonApi
 
     attr_accessor(*OPTION_NAMES)
 
+    READ_ONLY_OPTIONS = [
+      :wialon_session_identifier,
+      :wialon_client_session_identifier
+    ]
+
+    attr_reader(*READ_ONLY_OPTIONS)
+
     alias_method :log_requests?,  :log_requests
     alias_method :log_errors?,    :log_errors
     alias_method :log_responses?, :log_responses
 
     DEFAULT_WIALON_HOST = 'https://hst-api.wialon.com/wialon/ajax.html'
     DEFAULT_WIALON_EDITION = :hosting
+    DEFAULT_SESSION_IDENTIFIER = :sid
+    DEFAULT_CLIENT_SESSION_IDENTIFIER = :eid
     DEFAULT_HTTP_VERB = :post
     DEFAULT_MAX_RETRIES = 1
     DEFAULT_ADAPTER = Faraday.default_adapter
@@ -40,6 +49,8 @@ module WialonApi
     def reset
       @wialon_host = DEFAULT_WIALON_HOST
       @wialon_edition = DEFAULT_WIALON_EDITION
+      @wialon_session_identifier = DEFAULT_SESSION_IDENTIFIER
+      @wialon_client_session_identifier = DEFAULT_CLIENT_SESSION_IDENTIFIER
       @http_verb   = DEFAULT_HTTP_VERB
       @max_retries = DEFAULT_MAX_RETRIES
       @faraday_options = {}
@@ -53,5 +64,13 @@ module WialonApi
     def self.extended(base)
       base.reset
     end
+
+    def wialon_edition=(edition)
+      @wialon_edition = edition
+      if edition == :pro
+        @wialon_session_identifier = :ssid
+        @wialon_client_session_identifier = :ssid
+      end
+    end
   end
 end

data/lib/wialon_api/version.rb

@@ -1,3 +1,3 @@
 module WialonApi
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/wialon_api/authorization_spec.rb

@@ -12,16 +12,6 @@ describe WialonApi::Authorization do
       WialonApi.authorize(*credentials)
     end
 
-    it "uses ssid with wialon pro edition" do
-      success = Hashie::Mash.new(ssid: 'sid')
-      allow(WialonApi::Api).to receive(:call).and_return(success)
-      WialonApi.configure do |config|
-        config.wialon_edition = :pro
-      end
-      expect(WialonApi::Client).to receive(:new).with('sid')
-      WialonApi.authorize(*credentials)
-    end
-
     it 'raises an error if password or login do not match' do
       allow(WialonApi::Api).to receive(:call).and_return(error)
       expect { WialonApi.authorize(*credentials) }.to raise_error(WialonApi::Error)

data/spec/wialon_api/configuration_spec.rb

@@ -22,6 +22,8 @@ describe WialonApi::Configuration do
       TestConfiguration.reset
       expect(TestConfiguration.wialon_host).to eq('https://hst-api.wialon.com/wialon/ajax.html')
       expect(TestConfiguration.wialon_edition).to eq(:hosting)
+      expect(TestConfiguration.wialon_session_identifier).to eq(:sid)
+      expect(TestConfiguration.wialon_client_session_identifier).to eq(:eid)
       expect(TestConfiguration.http_verb).to eq(:post)
       expect(TestConfiguration.max_retries).to eq(1)
       expect(TestConfiguration.faraday_options).to eq({})
@@ -33,4 +35,21 @@ describe WialonApi::Configuration do
       expect(TestConfiguration.log_responses).not_to eq(true)
     end
   end
+
+  describe 'Wialon edition specific params' do
+    describe 'Pro edition' do
+      before do
+        TestConfiguration.reset
+        TestConfiguration.configure do |config|
+          config.wialon_edition = :pro
+        end
+      end
+
+      it 'sets pro edition params when setting edition' do
+        expect(TestConfiguration.wialon_edition).to eq(:pro)
+        expect(TestConfiguration.wialon_session_identifier).to eq(:ssid)
+        expect(TestConfiguration.wialon_client_session_identifier).to eq(:ssid)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wialon_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Arsen Shamkhalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-06 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake