wpa_cli_ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzdlMDNkNGI4NzczYmEwZTVmNjc4ODgxYjVkMGVlOTYyZTFkNGNkMA==
+    YmFhNTkxZjFiNzlhYTAzNDgxYzE3MzJjZTA5YjM3ZTljZWU4NjAzYQ==
   data.tar.gz: !binary |-
-    YTI2ZWE0ZWJmMzRlMjYyYWU4NTlmYjU3ZWM5NDUzMDg4NDAxYmZiOA==
+    OWZmMDQ2OTQ3Y2JlNzI5MTE2MGZhMTA1MTcyZGEzMzU3MTZkOWY5NQ==
 SHA512:
   metadata.gz: !binary |-
-    NDYxM2Y1ZTcxYWJmMzM1ZDVlZjRkZDY1NTgzYmZhZTE0NDJkM2ZjMGNjZTM1
-    MjY2NTkxMTFlMGU5NTI5MGU5YWRlZGM2MmU1MDhkOWM1YmU4NmJlMGU2Zjk3
-    MDEyZTg4ZGI4YzA5N2ZjNDVjNzljZDZiMmMxODhhMzIzMGViYzM=
+    MDhmMDljOGFkNmRmNjM1NDA1YWYwYWEyMzE3OWY4YWE0NjhlMGIxNzMwNDQz
+    NmI5NDNjYTIyMzkyMmM1YjEwM2VhZDk0YTY0N2RmY2Y0NzRmYTQ2YjgyODdk
+    NDJlYTk4NzllMzMzMjQyYzIxOGZlNDg3MTIyMWQ1NjAyOTc1N2Y=
   data.tar.gz: !binary |-
-    MzI0NzNlOTVkMTZkMjk3MTRkMDViNGY5MGI5N2I1NGJiNzg0OTNlMjE4MzJh
-    MmQ1ZGQwMmM1ZjI3YzU5NDgzZmVmMmUxZWJjMmJkOGQ5ZGFlMTdhYWJmMWIx
-    NjUzZDc4MWJiMDZlNjhjNzdkZDg0ZGJmZjFkZDNiNWYyZTQxODc=
+    MzNkZWVhZGFmNzU1YjUyNTk0YWM2Y2IyMTA3ODFjNWEzZmVhYTVlODUwZmYw
+    OGY4Yjc1ZjFiNGYzNDZhYmI5ZDA2OGUzZDY4ZWU5MjZkN2MxZGJiZTU5Y2Ri
+    NWJmMzlmYzVhMDg2M2I3MmU5N2VmZTk1ZTdkMGVhZmU4YmVjN2M=

data/AUTHORS

@@ -1,3 +1,7 @@
 AUTHORS
 
 - Chris Lowis <chris.lowis at bbc.co.uk>
+
+Contributors
+
+- Jordan S <https://github.com/JSchaenzle>

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in wpa_cli_ruby.gemspec
 gemspec
+gem 'mocha'

data/lib/wpa_cli_ruby/dummy_wpa_cli_wrapper.rb

@@ -42,5 +42,14 @@ eos
     def save_config
       "Selected interface 'wlan0'\nOK\n"
     end
+
+    def list_networks
+      response = <<-eos
+Selected interface 'wlan0'
+network id / ssid / bssid / flags
+0	My Awesome Network	any	[CURRENT]
+eos
+	  end
+
   end
 end

data/lib/wpa_cli_ruby/version.rb

@@ -1,3 +1,3 @@
 module WpaCliRuby
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/wpa_cli_ruby/wpa_cli.rb

@@ -1,5 +1,6 @@
 module WpaCliRuby
   class EnableNetworkFailure < Exception; end
+  class SelectNetworkFailure < Exception; end
   class SetNetworkFailure < Exception; end
   class NetworkNotFound < Exception; end
   class SaveConfigFailure < Exception; end
@@ -20,12 +21,45 @@ module WpaCliRuby
       end
     end
 
+    class ListNetworkResult < Struct.new(:network_id, :ssid, :bssid, :flags)
+      def initialize(*args)
+        super(*args)
+      end
+
+      # Instantiate from a tab delimited string (as given by `wpa_cli list_networks`)
+      #
+      # @param [String] tab delimited string in the form network_id\tssid\tbssid\tflags
+      def self.from_string(string)
+        new(*string.split("\t"))
+      end
+    end
+
     class Response < Struct.new(:interface, :status)
       def ok?
         status == "OK"
       end
     end
 
+    class StatusResponse
+      attr_reader :interface
+
+      def initialize(iface, items)
+        @interface = iface
+        @items = items
+      end
+
+      def method_missing(meth, *args, &block)
+        if not @items[meth.to_s].nil?
+          # run_find_by_method($1, *args, &block)
+          @items[meth.to_s]
+        else
+          super # You *must* call super if you don't handle the
+                # method, otherwise you'll mess up Ruby's method
+                # lookup.
+        end
+      end
+    end
+
     def initialize(wrapper = WpaCliWrapper.new)
       @wrapper = wrapper
     end
@@ -41,6 +75,12 @@ module WpaCliRuby
       results.map { |result| ScanResult.from_string(result) }
     end
 
+    def list_networks
+      response = @wrapper.list_networks
+      interface, header, *results = response.split("\n")
+      results.map { |result| ListNetworkResult.from_string(result) }
+    end
+
     def add_network
       response = @wrapper.add_network
       _, status = response.split("\n")
@@ -80,11 +120,35 @@ module WpaCliRuby
       response
     end
 
+    def select_network(network_id)
+      response = @wrapper.select_network(network_id)
+      response = parse_interface_status_response(response)
+      raise SelectNetworkFailure unless response.ok?
+
+      response
+    end
+
+    def get_status
+      response = @wrapper.get_status
+      parse_status_response(response)
+    end
+
+    def set_ap_scan(val)
+      @wrapper.set_ap_scan(val)
+    end
+
     private
     def parse_interface_status_response(response)
       interface_response, status = response.split("\n")
       interface = interface_response.scan(/'(.*)'/).flatten.first
       Response.new(interface, status)
     end
+
+    def parse_status_response(response)
+      interface_response, *status = response.split("\n")
+      interface = interface_response.scan(/'(.*)'/).flatten.first
+      status_items = Hash[status.map{|s| s.split("=")}]
+      StatusResponse.new(interface, status_items)
+    end
   end
 end

data/lib/wpa_cli_ruby/wpa_cli_wrapper.rb

@@ -1,47 +1,60 @@
 module WpaCliRuby
   class WpaCliWrapper
-    def execute(cmd)
-      %x[#{cmd}]
+    
+    def execute(*args)
+      IO.popen(["wpa_cli"] + args) do |io|
+        io.read
+      end
     end
-
+    
     def self.available?
       system("which wpa_cli > /dev/null 2>&1")
     end
 
     def scan
-      cmd = "wpa_cli scan"
-      execute(cmd)
+      execute("scan")
     end
 
     def scan_results
-      cmd = "wpa_cli scan_results"
-      execute(cmd)
+      execute("scan_results")
     end
 
     def add_network
-      cmd = "wpa_cli add_network"
-      execute(cmd)
+      execute("add_network")
     end
 
     def set_network(network_id, key, value)
-      value = "\"#{value}\"" unless value.is_a? Symbol
-      cmd = "wpa_cli set_network #{network_id} #{key} '#{value}'"
-      execute(cmd)
+      value = "\"#{value}\"" unless value.is_a?(Symbol)
+      execute("set_network", "#{network_id}", key, value.to_s)
     end
 
     def get_network(network_id, key)
-      cmd = "wpa_cli get_network #{network_id} #{key}"
-      execute(cmd)
+      execute("get_network", "#{network_id}", key)
+    end
+
+    def list_networks
+      execute("list_networks")
     end
 
     def enable_network(network_id)
-      cmd = "wpa_cli enable_network #{network_id}"
-      execute(cmd)
+      execute("enable_network", "#{network_id}")
+    end
+    
+    def select_network(network_id)
+      execute("select_network", "#{network_id}")
     end
 
     def save_config
-      cmd = "wpa_cli save_config"
-      execute(cmd)
+      execute("save_config")
     end
+  
+    def get_status
+      execute("status")
+    end
+
+    def set_ap_scan(val)
+      execute("ap_scan", val.to_s)
+    end
+
   end
 end

data/test/lib/wpa_cli_ruby/wpa_cli_test.rb

@@ -90,6 +90,10 @@ describe WpaCliRuby do
     end
   end
 
+  describe "list_networks" do
+    
+  end
+
   describe "scan_results" do
     before do
       response = <<-eos
@@ -110,6 +114,90 @@ eos
       assert_equal 2437, scan_results[0].frequency
 
       assert_equal 'ssid2', scan_results[1].ssid
+      assert_equal -57, scan_results[1].signal_level
+      assert_equal 2412, scan_results[1].frequency
     end
   end
+
+  describe "get_status" do
+
+    describe "when disconnected" do
+      before do
+        response = <<-eos
+Selected interface 'wlan0'
+wpa_state=DISCONNECTED
+address=80:1f:02:94:4c:f3
+eos
+        @wrapper.expects(:get_status).returns(response)
+      end
+
+      it "returns interface value of wlan0" do
+        status = @wpa_cli.get_status
+        assert_equal "wlan0", status.interface 
+      end
+
+      it "returns wpa_state value of DISCONNECTED" do
+        # status_results = @wpa_cli.status
+        status = @wpa_cli.get_status
+        assert_equal "DISCONNECTED", status.wpa_state
+      end
+
+      it "returns address value of 80:1f:02:94:4c:f3" do
+        status = @wpa_cli.get_status
+        assert_equal "80:1f:02:94:4c:f3", status.address
+      end
+
+    end
+
+    describe "when connected to a WPA2 network" do
+      before do
+        response = <<-eos
+Selected interface 'wlan1'
+bssid=64:0f:29:09:6d:d9
+ssid=A Great Network
+id=0
+mode=station
+pairwise_cipher=CCMP
+group_cipher=TKIP
+key_mgmt=WPA2-PSK
+wpa_state=COMPLETED
+ip_address=192.168.11.105
+address=80:1f:02:94:4c:f3
+eos
+        @wrapper.expects(:get_status).returns(response)
+      end
+
+      it "returns interface value of wlan1" do
+        status = @wpa_cli.get_status
+        assert_equal "wlan1", status.interface 
+      end
+
+      it "returns id value of 0" do
+        status = @wpa_cli.get_status
+        assert_equal "0", status.id 
+      end
+
+      it "returns wpa_state value of COMPLETED" do
+        status = @wpa_cli.get_status
+        assert_equal "COMPLETED", status.wpa_state 
+      end
+
+      it "returns ssid value of A Great Network" do
+        status = @wpa_cli.get_status
+        assert_equal "A Great Network", status.ssid 
+      end
+
+      it "returns group_cipher value of TKIP" do
+        status = @wpa_cli.get_status
+        assert_equal "TKIP", status.group_cipher 
+      end
+
+      it "returns key_mgmt value of WPA2-PSK" do
+        status = @wpa_cli.get_status
+        assert_equal "WPA2-PSK", status.key_mgmt 
+      end
+
+    end
+
+  end
 end

data/test/lib/wpa_cli_ruby/wpa_cli_wrapper_test.rb

@@ -7,54 +7,75 @@ describe WpaCliRuby do
 
   describe "scan" do
     it "calls execute with the correct string" do
-      @wrapper.expects(:execute).with("wpa_cli scan")
+      @wrapper.expects(:execute).with("scan")
       @wrapper.scan
     end
   end
 
   describe "scan_results" do
     it "calls execute with the correct string" do
-      @wrapper.expects(:execute).with("wpa_cli scan_results")
+      @wrapper.expects(:execute).with("scan_results")
       @wrapper.scan_results
     end
   end
 
   describe "add_network" do
     it "calls execute with the correct string" do
-      @wrapper.expects(:execute).with("wpa_cli add_network")
+      @wrapper.expects(:execute).with("add_network")
       @wrapper.add_network
     end
   end
 
   describe "set_network" do
     it "calls execute with the correct string" do
-      @wrapper.expects(:execute).with("wpa_cli set_network 0 ssid '\"network_ssid\"'")
+      @wrapper.expects(:execute).with("set_network", "0", "ssid", "\"network_ssid\"")
       @wrapper.set_network(0, 'ssid', 'network_ssid')
     end
     it "treats symbols as unquoted values" do
-      @wrapper.expects(:execute).with("wpa_cli set_network 0 key_mgmt 'NONE'")
+      @wrapper.expects(:execute).with("set_network", "0", "key_mgmt", "NONE")
       @wrapper.set_network(0, 'key_mgmt', :NONE)
     end
   end
 
   describe "get_network" do
     it "calls execute with the correct string" do
-      @wrapper.expects(:execute).with("wpa_cli get_network 0 ssid")
+      @wrapper.expects(:execute).with("get_network", "0", "ssid")
       @wrapper.get_network(0, 'ssid')
     end
   end
 
   describe "enable_network" do
     it "calls execute with the correct string" do
-      @wrapper.expects(:execute).with("wpa_cli enable_network 0")
+      @wrapper.expects(:execute).with("enable_network", "0")
       @wrapper.enable_network(0)
     end
   end
 
   describe "save_config" do
     it "calls execute with the correct string" do
-      @wrapper.expects(:execute).with("wpa_cli save_config")
+      @wrapper.expects(:execute).with("save_config")
       @wrapper.save_config
     end
   end
+
+  describe "list_networks" do
+    it "calls execute with correct string" do
+      @wrapper.expects(:execute).with("list_networks")
+      @wrapper.list_networks
+    end
+  end
+
+  describe "get_status" do
+    it "calls execute with correct string" do
+      @wrapper.expects(:execute).with("status")
+      @wrapper.get_status
+    end
+  end
+
+  describe "set_ap_scan" do
+    it "calls execute with correct value" do
+      @wrapper.expects(:execute).with("ap_scan", "1")
+      @wrapper.set_ap_scan(1)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wpa_cli_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Chris Lowis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2014-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler