lelylan-rb 0.0.1

data/lib/lelylan/client/categories.rb

@@ -0,0 +1,112 @@
+module Lelylan
+  class Client
+    module Categories
+
+      # Public: Returns extended information for a given category identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/types/categories/#get Lelylan Dev Center}.
+      #
+      # category - A String that represent the category URI.
+      #
+      # Returns Hashie The category.
+      #
+      # Examples
+      #
+      #   category = "http://api.lelylan.com/categories/4dcb9e23d033a9088902200a"
+      #   client.category(category)
+      #
+      def category(category)
+        get("/categories/#{find_id(category)}")
+      end
+
+      # Public: Returns a list of categories.
+      # Find more at {http://dev.lelylan.com/rest/types/categories/#all Lelylan Dev Center}.
+      #
+      # options - The Hash option used to refine the search (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/types/categories/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of categories.
+      #
+      # Examples
+      # 
+      #   # Retrurns the first 10 categories
+      #   client.categories(per: 10)
+      #
+      #   # Returns the categories where the name match with the desired string
+      #   client.categories(name: 'Lighting')
+      #
+      def categories(options = {})
+        get("/categories", options)
+      end
+
+      # Public: Returns a list of all public categories.
+      # Find more at {http://dev.lelylan.com/rest/categories/core/#all Lelylan Dev Center}.
+      #
+      # options - The Hash option used to refine the search (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/categories/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of categories.
+      #
+      # Examples
+      # 
+      #   # Retrurns the first 10 public categories
+      #   client.public_categories(per: 10)
+      #
+      def public_categories(options = {})
+        get("/categories/public", options)
+      end
+
+      # Public: Create a category and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/types/categories/#create Lelylan Dev Center}.
+      #
+      # options - The Hash option used to create the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/types/categories/#create API doc} for the accepted options.
+      # 
+      # Returns Hashie The created category.
+      #
+      # Examples
+      #
+      #   client.create_category(name: 'Lighting')
+      #
+      def create_category(options = {})
+        post("/categories", options)
+      end
+
+      # Public: Update a category identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/types/categories/#update Lelylan Dev Center}.
+      #
+      # category - A String that represents the category URI.
+      # options - The Hash option used to update the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/types/categories/#update API doc} for the accepted options.
+      # 
+      # Returns Hashie The updated category.
+      #
+      # Examples
+      # 
+      #   category = "http://api.lelylan.com/categories/4dcb9e23d033a9088902200a"
+      #   client.update_category(category, name: 'Lighting RGB')
+      #
+      def update_category(category, options = {})
+        put("/categories/#{find_id(category)}", options)
+      end
+
+      # Public: Delete a category identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/types/categories/#delete Lelylan Dev Center}.
+      #
+      # category - A String that represent the category URI.
+      # 
+      # Returns Hashie The deleted category.
+      #
+      # Examples
+      # 
+      #   category = "http://api.lelylan.com/categories/4dcb9e23d033a9088902200a"
+      #   client.delete_category(category)
+      #
+      def delete_category(category)
+        delete("/categories/#{find_id(category)}")
+      end
+    end
+  end
+end
+
+
+

data/lib/lelylan/client/consumptions.rb

@@ -0,0 +1,93 @@
+module Lelylan
+  class Client
+    module Consumptions
+
+      # Public: Returns extended information for a given consumption identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/devices/consumptions/#get Lelylan Dev Center}.
+      #
+      # consumption - A String that represent the consumption URI.
+      #
+      # Returns Hashie The consumption.
+      #
+      # Examples
+      #
+      #   consumption = "http://api.lelylan.com/consumption/4dcb9e23d033a9088902200a"
+      #   client.consumption(consumption)
+      #
+      def consumption(consumption)
+        get("/consumptions/#{find_id(consumption)}")
+      end
+
+      # Public: Returns extended information for a given consumption identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/devices/consumptions/#all Lelylan Dev Center}.
+      #
+      # options - The Hash option used to refine the search (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/consumptions/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of consumptions.
+      #
+      # Examples
+      # 
+      #   # Retrurns the first 10 consumptions
+      #   client.consumptions(per: 10)
+      #
+      #   # Returns the device consumptions from yesterday till now
+      #   client.consumptions(from: 'yesterday')
+      #
+      def consumptions(options = {})
+        get("/consumptions", options)
+      end
+
+      # Public: Create a consumption and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/devices/consumptions/#create Lelylan Dev Center}.
+      #
+      # options - The Hash option used to create the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/consumptions/#create API doc} for the accepted options.
+      # 
+      # Returns Hashie The created consumption.
+      #
+      # Examples
+      # 
+      #   device = "http://api.lelylan.com/devices/4dcb9e23d033a9088900000a"
+      #   client.create_conumption(device: device, value: 0.05, occur_at: "2025-08-17 07:50:16 +0200", duration: "1")
+      #
+      def create_consumption(options = {})
+        post("/consumptions", options)
+      end
+
+      # Public: Update a consumption identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/devices/consumptions/#update Lelylan Dev Center}.
+      #
+      # consumption - A String that represent the consumption URI.
+      # options - The Hash option used to update the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/consumptions/#update API doc} for the accepted options.
+      # 
+      # Returns Hashie The updated consumption.
+      #
+      # Examples
+      # 
+      #   consumption = "http://api.lelylan.com/consumptions/4dcb9e23d033a9088902200a"
+      #   client.update_consumption(consumption, value: '0.04')
+      #
+      def update_consumption(consumption, options = {})
+        put("/consumptions/#{find_id(consumption)}", options)
+      end
+
+      # Public: Delete a consumption identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/devices/consumptions/#delete Lelylan Dev Center}.
+      #
+      # consumption - A String that represent the consumption URI.
+      # 
+      # Returns Hashie The deleted consumption.
+      #
+      # Examples
+      # 
+      #   consumption = "http://api.lelyla.com/consumptions/4dcb9e23d033a9088902200a"
+      #   client.delete_consumption(consumption)
+      #
+      def delete_consumption(consumption)
+        delete("/consumptions/#{find_id(consumption)}")
+      end
+    end
+  end
+end

data/lib/lelylan/client/devices.rb

@@ -0,0 +1,211 @@
+module Lelylan
+  class Client
+    module Devices
+
+      # Public: Returns extended information for a given device
+      # identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/devices/core/#get Lelylan Dev Center}.
+      #
+      # device - A String that represent the device URI.
+      #
+      # Returns Hashie The device.
+      #
+      # Examples
+      #
+      #   device = "http://api.lelylan.com/devices/4dcb9e23d033a9088900000a"
+      #   client.device(device)
+      #
+      def device(device)
+        get("/devices/#{find_id(device)}")
+      end
+
+      # Public: Returns a list of owned devices.
+      # Find more at {http://dev.lelylan.com/rest/devices/core/#all Lelylan Dev Center}.
+      #
+      # options - The Hash option used to refine the search (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/core/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of devices.
+      #
+      # Examples
+      # 
+      #   # Returns the first 25 devices
+      #   client.devices
+      #
+      #   # Retrurns the first 10 devices
+      #   client.devices(per: 10)
+      #
+      #   # Returns the devices of a specific type
+      #   type = "http://api.lelylan.com/types/4dcb9e23d033a9088900023a"
+      #   client.devices(type: type)
+      #
+      def devices(options = {})
+        get("/devices", options)
+      end
+
+      # Public: Create a device and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/devices/core/#create Lelylan Dev Center}.
+      #
+      # options - The Hash option used to create the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/core/#create API doc} for the accepted options.
+      # 
+      # Returns Hashie The created device.
+      #
+      # Examples
+      # 
+      #   type = "http://api.lelyla.com/types/4dcb9e23d033a9088900023a"
+      #   client.create_device(name: "Dimmer", type: type)
+      #
+      def create_device(options = {})
+        post("/devices", options)
+      end
+
+      # Public: Update a device identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/devices/core/#update Lelylan Dev Center}.
+      #
+      # device - A String that represent the device URI.
+      # options - The Hash option used to update the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/core/#update API doc} for the accepted options.
+      # 
+      # Returns Hashie The updated device.
+      #
+      # Examples
+      # 
+      #   device = "http://api.lelyla.com/devices/4dcb9e23d033a9088900000a"
+      #   client.update_device(device, name: 'Closed dimmer')
+      #
+      def update_device(device, options = {})
+        put("/devices/#{find_id(device)}", options)
+      end
+
+      # Public: Delete a device identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/devices/core/#delete Lelylan Dev Center}.
+      #
+      # device - A String that represent the device URI.
+      # 
+      # Returns Hashie The deleted device.
+      #
+      # Examples
+      # 
+      #   device = "http://api.lelyla.com/devices/4dcb9e23d033a9088900000a"
+      #   client.delete_device(device)
+      #
+      def delete_device(device)
+        delete("/devices/#{find_id(device)}")
+      end
+
+      # Public: Execute a function on a device identified from its URI and returns extended representation for it.
+      # Find more at {http://dev.lelylan.com/rest/devices/functions/#update Lelylan Dev Center}.
+      #
+      # device - A String that represent the device URI.
+      # function - A string that represent the function URI to execute
+      # options - The Hash option used to update the resource properties (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/functions/#update API doc} for the accepted options.
+      # 
+      # Returns Hashie The device with the updated properties.
+      #
+      # Examples
+      #
+      #   device     = "http://api.lelyla.com/devices/4dcb9e23d033a9088900000a"
+      #   function   = "http://api.lelyla.com/functions/4dcb9e23d033a9088900020a"
+      #   properties = [{uri: "http://api.lelylan.com/functions/4dcb9e23d033a9088900020a", value: "50"}]
+      #
+      #   client.execute(device, function, properties: properties)
+      #
+      def execute(device, function, options={})
+        put("/devices/#{find_id(device)}/functions?uri=#{function}", options)
+      end
+
+      # Public: Update properties on a device identified from its URI and returns extended representation for it.
+      # Find more at {http://dev.lelylan.com/rest/devices/properties/#update Lelylan Dev Center}.
+      #
+      # device - A String that represent the device URI.
+      # options - The Hash option used to update the resource properties (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/properties/#update API doc} for the accepted options.
+      # 
+      # Returns Hashie The device with the updated properties.
+      #
+      # Examples
+      #
+      #   device     = "http://api.lelyla.com/devices/4dcb9e23d033a9088900000a"
+      #   properties = [{uri: "http://api.lelylan.com/functions/4dcb9e23d033a9088900020a", value: "50"}]
+      #
+      #   client.update_properties(device, function, properties: properties)
+      #
+      def update_properties(device, options={})
+        put("/devices/#{find_id(device)}/properties", options)
+      end
+
+      # Public: Create the connection between a device and a physical device.
+      # Find more at {http://dev.lelylan.com/rest/devices/physical/#update Lelylan Dev Center}.
+      #
+      # device - A String that represent the device URI.
+      # options - The Hash option containing the physcial device to connect (default: {}). Check out the {http://dev.lelylan.com/rest/devices/physical/#update API doc} for the accepted options.
+      # 
+      # Returns Hashie The device with the connected physical device.
+      #
+      # Examples
+      #
+      #   device   = "http://api.lelyla.com/devices/4dcb9e23d033a9088900000a"
+      #   physical = "http://node.lelylan.com/devices/8ecfd3a9b9a0e4"
+      #
+      #   client.update_properties(device, uri: physical)
+      #
+      def connect_physical(device, options={})
+        put("/devices/#{find_id(device)}/physical", options)
+      end
+
+      # Public: Delete the connection between a device and a physical device.
+      # Find more at {http://dev.lelylan.com/rest/devices/physical/#delete Lelylan Dev Center}.
+      #
+      # device - A String that represent the device URI.
+      # 
+      # Returns Hashie The device with the removed connection to the physical device.
+      #
+      # Examples
+      #
+      #   device = "http://api.lelyla.com/devices/4dcb9e23d033a9088900000a"
+      #   client.update_properties(device)
+      #
+      def disconnect_physical(device, options={})
+        delete("/devices/#{find_id(device)}/physical")
+      end
+
+      # Public: Returns the pending resource for a given device identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/devices/pending/#get Lelylan Dev Center}.
+      #
+      # device - A String that represent the device URI.
+      # 
+      # Returns Hashie The pending resource. What does {http://dev.lelylan.com/rest/devices/pending/ pending} mean?
+      #
+      # Examples
+      #
+      #   device = "http://api.lelyla.com/devices/4dcb9e23d033a9088900000a"
+      #   client.pending(device)
+      #
+      def pending(device)
+        get("/devices/#{find_id(device)}/pending")
+      end
+
+      # Public: Update the pending resource for a given device identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/devices/pending/#update Lelylan Dev Center}.
+      #
+      # device - A String that represent the device URI.
+      # pending - A String that represent the pending phase (start, update and close).
+      # options - The Hash option used to update the resource properties (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/properties/#update API doc} for the accepted options.
+      #
+      # Returns Hashie The updated pending resource. What does {http://dev.lelylan.com/rest/devices/pending/ pending} mean?
+      #
+      # Examples
+      #
+      #   device     = "http://api.lelyla.com/devices/4dcb9e23d033a9088900000a"
+      #   properties = [{uri: "http://api.lelylan.com/functions/4dcb9e23d033a9088900020a", value: "50"}]
+      #   client.update_pending(device, 'start', properties: properties)
+      #
+      def update_pending(device, options={})
+        put("/devices/#{find_id(device)}/pending", options)
+      end
+    end
+  end
+end

data/lib/lelylan/client/functions.rb

@@ -0,0 +1,118 @@
+module Lelylan
+  class Client
+    module Functions
+
+      # Public: Returns extended information for a given function identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/types/functions/#get Lelylan Dev Center}.
+      #
+      # function - A String that represent the function URI.
+      #
+      # Returns Hashie The function.
+      #
+      # Examples
+      #
+      #   function = "http://api.lelylan.com/functions/4dcb9e23d033a9088902200a"
+      #   client.function(function)
+      #
+      def function(function)
+        get("/functions/#{find_id(function)}")
+      end
+
+      # Public: Returns a list of functions.
+      # Find more at {http://dev.lelylan.com/rest/types/functions/#all Lelylan Dev Center}.
+      #
+      # options - The Hash option used to refine the search (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/types/functions/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of functions.
+      #
+      # Examples
+      # 
+      #   # Retrurns the first 10 functions
+      #   client.functions(per: 10)
+      #
+      #   # Returns the functions where the name match with the desired string
+      #   client.functions(name: 'Turn on')
+      #
+      def functions(options = {})
+        get("/functions", options)
+      end
+
+      # Public: Returns a list of all public functions.
+      # Find more at {http://dev.lelylan.com/rest/functions/core/#all Lelylan Dev Center}.
+      #
+      # options - The Hash option used to refine the search (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/functions/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of functions.
+      #
+      # Examples
+      # 
+      #   # Retrurns the first 10 public functions
+      #   client.public_functions(per: 10)
+      #
+      def public_functions(options = {})
+        get("/functions/public", options)
+      end
+
+      # Public: Create a function and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/types/functions/#create Lelylan Dev Center}.
+      #
+      # options - The Hash option used to create the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/types/functions/#create API doc} for the accepted options.
+      # 
+      # Returns Hashie The created function.
+      #
+      # Examples
+      # 
+      #   # device properties
+      #   status    = https://api.lelylan.com/properties/4dcb9e23d033a9088902200b"
+      #   intensity = https://api.lelylan.com/properties/4dcb9e23d033a9088902200c"
+      #   # values the function is going to set
+      #   properties = [{uri: status, value: 'on'}, {uri: intensity}]
+      #   # create the function
+      #   client.create_function(name: 'Set intensity', properties: properties)
+      #
+      def create_function(options = {})
+        post("/functions", options)
+      end
+
+      # Public: Update a function identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/types/functions/#update Lelylan Dev Center}.
+      #
+      # function - A String that represents the function URI.
+      # options - The Hash option used to update the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/types/functions/#update API doc} for the accepted options.
+      # 
+      # Returns Hashie The updated function.
+      #
+      # Examples
+      # 
+      #   function = "http://api.lelylan.com/functions/4dcb9e23d033a9088902200d"
+      #   client.update_function(function, name: 'Set intensity')
+      #
+      def update_function(function, options = {})
+        put("/functions/#{find_id(function)}", options)
+      end
+
+      # Public: Delete a function identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/types/functions/#delete Lelylan Dev Center}.
+      #
+      # function - A String that represent the function URI.
+      # 
+      # Returns Hashie The deleted function.
+      #
+      # Examples
+      # 
+      #   function = "http://api.lelylan.com/functions/4dcb9e23d033a9088902200a"
+      #   client.delete_function(function)
+      #
+      def delete_function(function)
+        delete("/functions/#{find_id(function)}")
+      end
+    end
+  end
+end
+
+
+