guh 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa6cbfff073870eabcc433d92c9f92d48cb8bd0e
-  data.tar.gz: 34762aeabd46d3c0f8d7aa0aaaf6710d5f5c779f
+  metadata.gz: 4960d036bde4cfe611b3c45cbdff866a678ee12e
+  data.tar.gz: 74da9d4b1d55d32fb27894c106a0bd181a2220bb
 SHA512:
-  metadata.gz: 476d41353de9a87a7ee4585d9317b005e5a837ceccd34f0341c929c1ed0942b7e152387ab35b8382e1db81bbb97fd66ddd6819f403e7ea3a3d622d0c5c7446cd
-  data.tar.gz: 97c5ff55e9855e436e411905e4c628fee5e66193f214742f102380ec721347403e82df861884f248401dd61dbdeb55077ac588ddb50a5c3825af727385d01f54
+  metadata.gz: df55cfb07c687984a6b11991c24d93b0a238c2cd67553c8637ee388a0f078d184def691c387b9072e139dac036c4ae3b976b8d0589541d4148bfa924752a0628
+  data.tar.gz: 4d3ce2ff17641939e8e02b91fcd00774afd9bc869e206cc3de513ac4146f20b21ea62b8c5c97a68e7de6f6bd8c4153b831e96b10a97ffa18fe610783f39eb0be

data/Rakefile

@@ -12,6 +12,12 @@ task :console do
   require 'irb/completion'
   require 'pp'
   require 'guh'
+
+  Guh::Base.configure do |c|
+    c.guh_ip_address = '192.168.178.31'
+    c.guh_port = 1234
+  end
+
   ARGV.clear
   IRB.start
 end

data/lib/guh/base.rb

@@ -70,7 +70,7 @@ module Guh
     #
     # Example:
     #
-    #   Guh.configure do |config|
+    #   Guh::Base.configure do |config|
     #     config.guh_ip_address = 10.0.0.1
     #     config.guh_port = 6789
     #   end

data/lib/guh/device.rb

@@ -2,11 +2,21 @@ module Guh
   ##
   # This class wraps everything related to configured Devices.
   #
+  # TODO write up the creation of a normal device
+  #
+  # TODO write up the creation of a discoverable device.
+  #
   class Device < Base
 
 
     ##
     #
+    # Returns a specific configured Device.
+    #
+    # Example:
+    #
+    #   Guh::Device.find('{427a4a9a-c107-446f-aadf-f1b2abad607d1}')
+    #
     def self.find(id)
       device = self.all.detect{|d| d['id']==id}
 
@@ -30,6 +40,31 @@ module Guh
       return response['devices']
     end
 
+    ##
+    #
+    # Returns a list of recently discovered devices.
+    #
+    # Example:
+    #
+    #   Guh::Device.discover("{985195aa-17ad-4530-88a4-cdd753d747d7}", [{name: 'location', value: 'Salzburg'}])
+    #
+    def self.discover(device_class_id, discovery_params = {})
+      response = get({
+        id: generate_request_id,
+        method: "Devices.GetDiscoveredDevices",
+        params: {
+          deviceClassId: device_class_id,
+          discoveryParams: discovery_params
+        }
+      })
+
+      if response['success'] == true
+        return response['deviceDescriptors']
+      else
+        raise Guh::ResponseError, response['errorMessage']
+      end
+    end
+
     ##
     #
     # Creates a configured device and returns it's ID.
@@ -49,17 +84,41 @@ module Guh
     #     channel10: false
     #   })
     #
+    # To create a discovered device you have to provide a descriptor ID in the params:
+    #
+    #   Guh::Device.add("{985195aa-17ad-4530-88a4-cdd753d747d7}", {descriptorId: "{727a4a9a-c187-446f-aadf-f1b2220607d1}"})
+    #
     def self.add(device_class_id, params)
+      device_class = Guh::DeviceClass.find(device_class_id)
+
+      case device_class['createMethod']
+      when 'CreateMethodUser'
+        add_configured_device(device_class_id, params)
+      when 'CreateMethodDiscovery'
+        add_discovered_device(device_class_id, params[:descriptorId])
+      when 'CreateMethodAuto'
+        # Nothing to do here
+        # TODO should we raise an exception?
+      end
+    end
+
+    ##
+    #
+    # Finishes a pairing process with a device. The user might have to push a button on the device.
+    #
+    # The +pairing_transaction_id+ can be obtained with the +add_discovered_device()+ method.
+    #
+    def self.confirm_pairing(pairing_transaction_id)
       response = get({
         id: generate_request_id,
-        method: "Devices.AddConfiguredDevice",
+        method: "Devices.PairDevice",
         params: {
-          deviceClassId: device_class_id,
-          deviceParams: params
+          pairingTransactionId: pairing_transaction_id
         }
       })
+
       if response['success']==true
-        return response['deviceId']
+        return response
       else
         raise Guh::ArgumentError, response['errorMessage']
       end
@@ -100,5 +159,68 @@ module Guh
       self.all.length
     end
 
+    private
+
+    def self.add_configured_device(device_class_id, params)
+      response = get({
+        id: generate_request_id,
+        method: "Devices.AddConfiguredDevice",
+        params: {
+          deviceClassId: device_class_id,
+          deviceParams: params
+        }
+      })
+
+      if response['success']==true
+        return response['deviceId']
+      else
+        raise Guh::ArgumentError, response['errorMessage']
+      end
+    end
+
+    def self.add_discovered_device(device_class_id, descriptor_id)
+      device_class = Guh::DeviceClass.find(device_class_id)
+
+      if device_class['setupMethod'] == 'SetupMethodJustAdd'
+        add_discovered_device_just_add(device_class_id, descriptor_id)
+      else
+        add_discovered_device_pair(device_class_id, descriptor_id)
+      end
+    end
+
+    def self.add_discovered_device_just_add(device_class_id, descriptor_id)
+      response = get({
+        id: generate_request_id,
+        method: "Devices.AddConfiguredDevice",
+        params: {
+          deviceClassId: device_class_id,
+          deviceDescriptorId: descriptor_id
+        }
+      })
+
+      if response['success']==true
+        return response['deviceId']
+      else
+        raise Guh::ArgumentError, response['errorMessage']
+      end
+    end
+
+    def self.add_discovered_device_pair(device_class_id, descriptor_id)
+      response = get({
+        id: generate_request_id,
+        method: "Devices.PairDevice",
+        params: {
+          deviceClassId: device_class_id,
+          deviceDescriptorId: descriptor_id
+        }
+      })
+
+      if response['success']==true
+        return response
+      else
+        raise Guh::ArgumentError, response['errorMessage']
+      end
+    end
+
   end
 end

data/lib/guh/device_class.rb

@@ -47,24 +47,5 @@ module Guh
       end
     end
 
-    ##
-    #
-    def self.discover(id, options={})
-      params = {deviceClassId: id}
-      params['discoveryParams'] = options
-
-      response = get({
-        id: generate_request_id,
-        method: "Devices.GetDiscoveredDevices",
-        params: params
-      })
-
-      if response['success']
-        return response['deviceDescriptors']
-      else
-        raise ResponseError, response['errorMessage']
-      end
-    end
-
   end
 end

data/lib/guh/vendor.rb

@@ -3,6 +3,17 @@ module Guh
   # This class wraps everything related to Vendors.
   #
   class Vendor < Base
+    ##
+    #
+    # Retrieves a specific vendor
+    #
+    # Example:
+    #
+    #   Guh::Vendor.find('{b241f7f5-8153-4a72-b260-f62beadc2d19}')
+    #
+    def self.find(vendor_id)
+      all.detect { |vendor| vendor['id'] == vendor_id }
+    end
 
     ##
     #

data/lib/guh/version.rb

@@ -1,3 +1,3 @@
 module Guh
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/helper.rb

@@ -9,7 +9,7 @@ RSpec.configure do |config|
 
   config.before(:all) do
     Guh::Base.configure do |c|
-      c.guh_ip_address = "127.0.0.1"
+      c.guh_ip_address = '192.168.178.31'
       c.guh_port = 1234
     end
 

data/spec/integration/device_class_spec.rb

@@ -33,16 +33,4 @@ describe Guh::DeviceClass do
     end
   end
 
-  it "should discover the openweathermap" do
-
-    device_class_id = "{985195aa-17ad-4530-88a4-cdd753d747d7}"
-
-    pending "TODO wait until issue #13 is fixed"
-
-    # device_descriptors = Guh::DeviceClass.discover(device_class_id, [
-    #   {name: 'location', value: ''}
-    # ])
-
-  end
-
 end

data/spec/integration/device_spec.rb

@@ -19,15 +19,15 @@ describe Guh::Device do
 
     -> {
       response = Guh::Device.add("{308ae6e6-38b3-4b3a-a513-3199da2764f8}", [
-        {name: 'channel1',  value: true},
-        {name: 'channel2',  value: false},
-        {name: 'channel3',  value: false},
-        {name: 'channel4',  value: false},
-        {name: 'channel5',  value: false},
-        {name: 'A',  value: false},
-        {name: 'B',  value: false},
-        {name: 'C',  value: false},
-        {name: 'D',  value: false},
+        {name: 'channel1', value: true},
+        {name: 'channel2', value: false},
+        {name: 'channel3', value: false},
+        {name: 'channel4', value: false},
+        {name: 'channel5', value: false},
+        {name: 'A', value: false},
+        {name: 'B', value: false},
+        {name: 'C', value: false},
+        {name: 'D', value: false},
         {name: 'E', value: false}
       ])
     }.should_not raise_error
@@ -50,7 +50,7 @@ describe Guh::Device do
 
     device_id.should match(/^\{[a-z0-9\-]+\}$/i)
 
-    Guh::Device.remove(device_id).should be_true
+    Guh::Device.remove(device_id).should be_truthy
 
     Guh::Device.find(device_id).should be_nil
   end
@@ -61,4 +61,12 @@ describe Guh::Device do
     }.should raise_error
   end
 
+  it "should discover the openweathermap" do
+    device_class_id = "{985195aa-17ad-4530-88a4-cdd753d747d7}"
+
+    device_descriptors = Guh::Device.discover(device_class_id, [{name: 'location', value: 'Salzburg'}])
+
+    response = Guh::Device.add(device_class_id, {descriptorId: device_descriptors.first['id']})
+  end
+
 end

data/spec/integration/vendor_spec.rb

@@ -11,7 +11,11 @@ describe Guh::Vendor do
   end
 
   it "should return information about a specific vendor" do
-    pending "TODO: Implement Guh::Vendor.find('{abc}')"
+    vendor_id = '{b241f7f5-8153-4a72-b260-f62beadc2d19}'
+
+    vendor = Guh::Vendor.find(vendor_id)
+
+    vendor['id'].should eq(vendor_id)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guh
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Christoph Edthofer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-03 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json