ngi_api 0.0.5 → 0.0.6

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.5
+  - 2.2.0
+gemfile:
+  - Gemfile

data/README.md

@@ -1,6 +1,13 @@
 # NgiApi
 
-TODO: Write a gem description
+This library is a convenient, easy way to access NGI's API for resellers - simple object methods vs. custom SOAP calls. There are multiple built-in checks for type corrections, and the entered values are automatically adjusted. Return values are parsed and presented as a hash.
+This gem currently supports all API operations:
+* list_bts
+* list_comuni
+* info_bts
+* info_radio
+* reboot_radio
+* set_ethernet
 
 ## Installation
 
@@ -20,11 +27,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+See documentation!
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/ngi_api/fork )
+1. Fork it ( https://github.com/blacksd/ngi_api/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,2 +1,3 @@
 require "bundler/gem_tasks"
-Dir.glob('tasks/**/*.rake').each(&method(:import))
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+task :default => :spec

data/lib/ngi_api.rb

@@ -33,9 +33,9 @@ class NgiAPI
 		@partnerPassword = !!args[:test] ? "517fc7b578767ebfa6bb5252252653d2" : parameter_to_string(args[:partnerPassword])
         fetch_cacert unless File.exist?('cacert.pem')
         @soapClient = Savon.client do
-          wsdl !!args[:test] ? "https://www.eolo.it/ws/wsdl/?test" : "https://www.eolo.it/ws/wsdl"
+          wsdl !!args[:test] ? "https://www.eolo.it/ws/wsdl/?test" : "https://www.eolo.it/ws/wsdl/"
           ssl_ca_cert_file "cacert.pem"
-          if args[:debug]
+          if !!args[:debug]
             log true 
             log_level :debug 
             pretty_print_xml true
@@ -161,7 +161,7 @@ class NgiAPI
         )
     end
 
-    private
+    private # ------------------
 
     # formats the mac address for the request, stripping separators and upcasing it
     def fix_mac_address(mac)
@@ -203,28 +203,34 @@ class NgiAPI
         checksum = @partnerLogin
 
         case type
-        when :info_bts
-            checksum += params[:btsID]
-            message[:btsID] = params[:btsID]
-        when :list_comuni
-            checksum += params[:comune]
-            message[:comune] = params[:comune]
-        when :set_ethernet
-            checksum += params[:macAddress]
-            checksum += params[:statoEthernet]
-            message[:macAddress] = params[:macAddress]
-            message[:statoEthernet] = params[:statoEthernet]
-        when :reboot_radio
-            checksum += params[:macAddress]
-            message[:macAddress] = params[:macAddress]
-        when :info_radio
-            checksum += parameter_to_string(params[:macAddressList])
-            checksum += parameter_to_string(params[:clientLoginList])
-            message[:macAddressList] = {items: params[:macAddressList]}
-            message[:clientLoginList] = {items: params[:clientLoginList]}
-        when :list_bts # no input needed
+            when :info_bts
+                checksum += params[:btsID]
+                message[:btsID] = params[:btsID]
+            when :list_comuni
+                checksum += params[:comune]
+                message[:comune] = params[:comune]
+            when :set_ethernet
+                checksum += params[:macAddress]
+                checksum += params[:statoEthernet]
+                message[:macAddress] = params[:macAddress]
+                message[:statoEthernet] = params[:statoEthernet]
+            when :reboot_radio
+                checksum += params[:macAddress]
+                message[:macAddress] = params[:macAddress]
+            when :info_radio
+                checksum += parameter_to_string(params[:macAddressList])
+                checksum += parameter_to_string(params[:clientLoginList])
+                message[:macAddressList] = {items: params[:macAddressList]}
+                message[:clientLoginList] = {items: params[:clientLoginList]}
+            when :info_coverage
+                checksum += params[:via]
+                checksum += params[:civico]
+                checksum += params[:istat]
+                message[:via] = params[:via]
+                message[:civico] = params[:civico]
+                message[:istat] = params[:istat]
+            when :list_bts # no input needed
         end
-        
         message[:controlHash] = Digest::MD5.hexdigest(checksum+@partnerPassword)
         @soapClient.call(type, message: message).to_hash[(type.to_s+"_response").to_sym]
     end

data/lib/ngi_api/version.rb

@@ -1,4 +1,4 @@
 class NgiAPI
     # gem version
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
 end

data/spec/ngi_api_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe NgiAPI do
@@ -5,6 +7,35 @@ describe NgiAPI do
 		
 		before :all do
 	    	@myNgiAPI = NgiAPI.new({test: true})
+	    	@macstotest = [
+	    		# '00.aA.bB.cC.dD.11', 	# dots 
+	    		# '00:aA:bB:cC:dD:11',	# colons  
+	    		# '00-aA-bB-cC-dD-11',	# dashes
+	    		# '00aAbBcCdD11',		# no spaces
+	    		'00aA:bB.cC-dD-11'		# mixed
+	    	]
+	    	@zeroedmacstotest = [
+	    		# '00.00.00.00.00.00', 	# dots 
+	    		# '00:00:00:00:00:00',	# colons  
+	    		# '00-00-00-00-00-00',	# dashes
+	    		# '000000000000',		# no spaces
+	    		'0000:00.00-00-00'		# mixed
+	    	]
+	    	@onedmacstotest = [
+	    		# '11.11.11.11.11.11', 	# dots 
+	    		# '11:11:11:11:11:11',	# colons  
+	    		# '11-11-11-11-11-11',	# dashes
+	    		# '111111111111',		# no spaces
+	    		'1111:11.11-11-11'		# mixed
+	    	]
+	    	@loginstotest = [
+	    		# 'W12345678901'		# upcase
+	    		'w12345678901',			# lowcase
+	    	]
+	    	@zeroedloginstotest = [
+	    		# 'W00000000000'		# upcase
+	    		'w00000000000',			# lowcase
+	    	]
 		end
 
 		it 'can build a test instance' do 
@@ -30,37 +61,22 @@ describe NgiAPI do
 
 		describe '#infoRadio' do
 			# OKs
-			it 'is fine with a dot separated single mac' do 
-				expect(@myNgiAPI.infoRadio('00.aA.bB.cC.dD.11')[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
-			end
-			it 'is fine with a colon divided single mac' do 
-				expect(@myNgiAPI.infoRadio('00:aA:bB:cC:dD:11')[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
-			end
-			it 'is fine with a dashed single mac' do 
-				expect(@myNgiAPI.infoRadio('00-aA-bB-cC-dD-11')[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
-			end
-			it 'is fine with an unspaced single mac' do 
-				expect(@myNgiAPI.infoRadio('00aAbBcCdD11')[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
-			end
-			it 'is fine with a mixed separated single mac' do 
-				expect(@myNgiAPI.infoRadio('00aA:bB.cC-dD-11')[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
-			end
-			it 'is okay with a single lowercase login' do
-				expect(@myNgiAPI.infoRadio('w12345678901')[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
+			it 'is fine with a single mac' do 
+				@macstotest.each do |mac|
+					expect(@myNgiAPI.infoRadio(mac)[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
+				end
 			end
-			it 'is okay with a single uppercase login' do
-				expect(@myNgiAPI.infoRadio('W12345678901')[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
+
+			it 'is okay with a single login' do
+				@loginstotest.each do |login|
+					expect(@myNgiAPI.infoRadio(login)[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
+				end
 			end
+
 			it 'is fine with an array of mixed values' do
-				test_array = [
-					'00.aA.bB.cC.dD.11',
-					'00-aA-bB-cC-dD-11',
-					'00aAbBcCdD11',
-					'00aA:bB.cC-dD-11',
-					'w12345678901',
-					'W12345678901'
-				]
-				expect(@myNgiAPI.infoRadio(test_array)[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
+				(@macstotest + @loginstotest).each do |element|
+					expect(@myNgiAPI.infoRadio(element)[:info][:"@xsi:type"]).to eq("ns1:radioInfoListType")
+				end
 			end 
 
 			# KOs
@@ -72,56 +88,143 @@ describe NgiAPI do
 				expect{ @myNgiAPI.infoRadio(large_test_array) }.to raise_error(ArgumentError)
 			end
 			it 'fails with a mac value of 000000000000' do
-				expect{ @myNgiAPI.infoRadio('000000000000') }.to raise_error
-				expect{ @myNgiAPI.infoRadio('00.00.00.00.00.00') }.to raise_error
-				expect{ @myNgiAPI.infoRadio('00:00:00:00:00:00') }.to raise_error
-				expect{ @myNgiAPI.infoRadio('00-00-00-00-00-00') }.to raise_error
-				expect{ @myNgiAPI.infoRadio('000000:00.00-00') }.to raise_error
+				@zeroedmacstotest.each do |zeroedmac|
+					expect{ @myNgiAPI.infoRadio(zeroedmac) }.to raise_error
+				end
 			end
+
 			it 'fails with a login value of W00000000000' do
-				expect{ @myNgiAPI.infoRadio('W00000000000') }.to raise_error
-				expect{ @myNgiAPI.infoRadio('w00000000000') }.to raise_error
+				@zeroedloginstotest.each do |zeroedlogin|
+					expect{ @myNgiAPI.infoRadio(zeroedlogin) }.to raise_error
+				end
 			end
 
 		end
 
 		describe '#infoBts' do
 			# OKs
-			it 'returns sample data with a numeric param' do
-				expect( @myNgiAPI.infoBts(3)[:info_bts][:"@xsi:type"] ).to eq("ns1:BtsFullInfoType")
-			end
-
-			it 'returns sample data with a numeric string param' do
-				expect( @myNgiAPI.infoBts("3")[:info_bts][:"@xsi:type"] ).to eq("ns1:BtsFullInfoType")
+			it 'returns sample data' do
+				[
+					3,		# int
+					"3"		# string
+				].each do |bts_input|
+					expect( @myNgiAPI.infoBts(bts_input)[:info_bts][:"@xsi:type"] ).to eq("ns1:BtsFullInfoType")
+				end
 			end
 
 			# KOs
 			it 'throws an error with btsId < 1' do
-				expect{ @myNgiAPI.infoBts(0) }.to raise_error(ArgumentError)
-				expect{ @myNgiAPI.infoBts('0') }.to raise_error(ArgumentError)
+				[
+					0,		# int
+					"0"		# string
+				].each do |bts_input|
+					expect{ @myNgiAPI.infoBts(bts_input) }.to raise_error(ArgumentError)
+				end
 			end
 
 		end
 
 		describe '#infoCoverage' do
-
+			# OKs
+			it 'returns a list of matching BTSes for the address' do
+				expect( @myNgiAPI.infoCoverage("Viale Monza",12,"01234")[:lista_bts][:"@xsi:type"] ).to eq("ns1:BtsListType")
+			end
 		end
 
 		describe '#listComuni' do
+			# OKs
+			it 'returns a list of towns' do
+				expect( @myNgiAPI.listComuni("someteststring")[:lista_comuni][:"@xsi:type"] ).to eq("ns1:comuneListType")
+			end
+
+			it 'works fine with latin characters' do
+				expect( @myNgiAPI.listComuni("sometestàèéìòùstring")[:lista_comuni][:"@xsi:type"] ).to eq("ns1:comuneListType")
+			end
 
+			# KOs
+			it 'throws an error with a short (<2 chars) param' do
+				expect{ @myNgiAPI.listComuni("a") }.to raise_error(ArgumentError)
+			end
+
+			it 'throws an error with a long (>35 chars) param' do
+				expect{ @myNgiAPI.listComuni("areallylongstringthatshouldnotbeatown") }.to raise_error(ArgumentError)
+			end
+
+			it 'returns an empty list with a "nolist" param' do
+				expect( @myNgiAPI.listComuni("nolist")[:lista_comuni][:items] ).to be_nil
+			end
+
+			it 'throws an error with a "error" param' do
+				expect{ @myNgiAPI.listComuni("error") }.to raise_error
+			end
 		end
 
 		describe '#setEthernet' do
+			# OKs
+			it 'can enable an ethernet interface' do 
+				[
+					1,		# int
+					true	# bool
+				].each do |eth_enable_state|
+					@macstotest.each do |mac|
+						expect( @myNgiAPI.setEthernet(mac,eth_enable_state)[:stato_ethernet] ).to be true
+					end
+				end
+			end
 
+			it 'can disable an ethernet interface' do
+				[
+					0,		# int
+					false	# bool
+				].each do |eth_enable_state|
+					@macstotest.each do |mac|
+						expect( @myNgiAPI.setEthernet(mac,eth_enable_state)[:stato_ethernet] ).to be false
+					end
+				end
+			end
+
+			# KOs
+			it 'throws an error if mac is all 1s' do
+				[
+					true,	# bool
+					false
+				].each do |eth_state|
+					@onedmacstotest.each do |onedmac|
+						expect{ @myNgiAPI.setEthernet(onedmac,eth_state) }.to raise_error
+					end
+				end
+			end
+			
+			it 'always gets a false with a mac of all 0s' do
+				[
+					true,	# bool
+					false
+				].each do |eth_state|
+					@zeroedmacstotest.each do |zeroedmac|
+						expect( @myNgiAPI.setEthernet(zeroedmac,eth_state)[:stato_ethernet] ).to be false
+					end
+				end
+			end
 		end
 
 		describe '#rebootRadio' do
 			# OKs
-			it 'returns true'
+			it 'returns true' do
+				@macstotest.each do |mac|
+					expect( @myNgiAPI.rebootRadio(mac)[:esito] ).to be true 
+				end
+			end
 
 			# KOs
-			it 'throws an error if mac address is invalid'			
-			it 'returns an error if mac is all 0s or all 1s'
+			it 'throws an error if mac address is invalid' do
+				expect{ @myNgiAPI.rebootRadio('someinvalidstring') }.to raise_error(ArgumentError)			
+			end
+
+			it 'returns an error if mac is all 0s or all 1s' do
+				(@zeroedmacstotest + @onedmacstotest).each do |mac|
+					expect{ @myNgiAPI.rebootRadio(mac) }.to raise_error
+				end
+			end
 		end
 	end
 

data/tasks/rspec.rake

@@ -1,3 +1,3 @@
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngi_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md