lelylan-rb 0.0.1

data/lib/lelylan/client/histories.rb

@@ -0,0 +1,42 @@
+module Lelylan
+  class Client
+    module Histories
+
+      # Public: Returns extended information for a given history identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/devices/history/#get Lelylan Dev Center}.
+      #
+      # history - A String that represents the history URI.
+      #
+      # Returns Hashie The history resource.
+      #
+      # Examples
+      #
+      #   history = "http://api.lelylan.com/histories/4dcb9e23d033a9088900200f"
+      #   client.history(history)
+      #
+      def history(history)
+        get("/histories/#{find_id(history)}")
+      end
+
+      # Public: Returns a list of history resources for a given device identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/devices/history/#all Lelylan Dev Center}.
+      #
+      # device - A String that represents the device URI.
+      # options - The Hash option used to refine the search (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/devices/history/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of histories.
+      #
+      # Examples
+      # 
+      #   # Returns the first 10 histories for a specific device)
+      #   device = "http://api.lelyla.com/devices/4dcb9e23d033a9088900023b"
+      #   client.histories(device, per: 10)
+      #
+      #
+      def histories(device, options = {})
+        get("/devices/#{find_id(device)}/histories", options)
+      end
+    end
+  end
+end

data/lib/lelylan/client/locations.rb

@@ -0,0 +1,92 @@
+module Lelylan
+  class Client
+    module Locations
+
+      # Public: Returns extended information for a given location identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/locations/#get Lelylan Dev Center}.
+      #
+      # location - A String that represent the location URI.
+      #
+      # Returns Hashie The location.
+      #
+      # Examples
+      #
+      #   location = "http://api.lelylan.com/location/4dcb9e23d033a9088902200a"
+      #   client.location(location)
+      #
+      def location(location)
+        get("/locations/#{find_id(location)}")
+      end
+
+      # Public: Returns extended information for a given location identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/locations/#all Lelylan Dev Center}.
+      #
+      # options - The Hash option used to refine the search (default: {}).
+      #           Check out the {http://dev.lelylan.com/rest/locations/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of locations.
+      #
+      # Examples
+      # 
+      #   # Retrurns the first 10 locations
+      #   client.locations(per: 10)
+      #
+      #   # Returns the device locations from yesterday till now
+      #   client.locations(type: 'room')
+      #
+      def locations(options = {})
+        get("/locations", options)
+      end
+
+      # Public: Create a location and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/locations/#create Lelylan Dev Center}.
+      #
+      # options - The Hash option used to create the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/location/#create API doc} for the accepted options.
+      # 
+      # Returns Hashie The created location.
+      #
+      # Examples
+      # 
+      #   client.create_location(name: 'Kids bedroom', type: 'room')
+      #
+      def create_location(options = {})
+        post("/locations", options)
+      end
+
+      # Public: Update a location identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/locations/#update Lelylan Dev Center}.
+      #
+      # location - A String that represent the location URI.
+      # options - The Hash option used to update the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/locations/#update API doc} for the accepted options.
+      # 
+      # Returns Hashie The updated location.
+      #
+      # Examples
+      # 
+      #   location = "http://api.lelylan.com/locations/4dcb9e23d033a9088902200a"
+      #   client.update_location(location, name: 'Big mama bedroom')
+      #
+      def update_location(location, options = {})
+        put("/locations/#{find_id(location)}", options)
+      end
+
+      # Public: Delete a location identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/locations/#delete Lelylan Dev Center}.
+      #
+      # location - A String that represent the location URI.
+      # 
+      # Returns Hashie The deleted location.
+      #
+      # Examples
+      # 
+      #   location = "http://api.lelyla.com/locations/4dcb9e23d033a9088902200a"
+      #   client.delete_location(location)
+      #
+      def delete_location(location)
+        delete("/locations/#{find_id(location)}")
+      end
+    end
+  end
+end

data/lib/lelylan/client/properties.rb

@@ -0,0 +1,115 @@
+module Lelylan
+  class Client
+    module Properties
+
+      # Public: Returns extended information for a given property identified from its URI.
+      # Find more at {http://dev.lelylan.com/rest/types/properties/#get Lelylan Dev Center}.
+      #
+      # property - A String that represent the property URI.
+      #
+      # Returns Hashie The property.
+      #
+      # Examples
+      #
+      #   property = "http://api.lelylan.com/properties/4dcb9e23d033a9088902200a"
+      #   client.property(property)
+      #
+      def property(property)
+        get("/properties/#{find_id(property)}")
+      end
+
+      # Public: Returns a list of properties.
+      # Find more at {http://dev.lelylan.com/rest/types/properties/#all Lelylan Dev Center}.
+      #
+      # options - The Hash option used to refine the search (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/types/properties/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of properties.
+      #
+      # Examples
+      # 
+      #   # Retrurns the first 10 properties
+      #   client.properties(per: 10)
+      #
+      #   # Returns the properties where the name match with the desired string
+      #   client.properties(name: 'Intensity')
+      #
+      def properties(options = {})
+        get("/properties", options)
+      end
+
+      # Public: Returns a list of properties.
+      # Find more at {http://dev.lelylan.com/rest/properties/properties/#all Lelylan Dev Center}.
+      #
+      # options - The Hash option used to refine the search (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/properties/properties/#all API doc} for the accepted options.
+      # 
+      # Returns Hashie List of properties.
+      #
+      # Examples
+      # 
+      #   # Retrurns the first 10 properties
+      #   client.properties(per: 10)
+      #
+      #   # Returns the properties where the name match with the desired string
+      #   client.properties(name: 'Intensity')
+      #
+      def public_properties(options = {})
+        get("/properties/public", options)
+      end
+
+      # Public: Create a property and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/types/properties/#create Lelylan Dev Center}.
+      #
+      # options - The Hash option used to create the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/types/properties/#create API doc} for the accepted options.
+      # 
+      # Returns Hashie The created property.
+      #
+      # Examples
+      #
+      #   values = 1..100.to_a # [0, 1, 2, 3, 4, ..., 99, 100]
+      #   client.create_property(name: 'Intensity', default: '0', values: values)
+      #
+      def create_property(options = {})
+        post("/properties", options)
+      end
+
+      # Public: Update a property identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/types/properties/#update Lelylan Dev Center}.
+      #
+      # property - A String that represents the property URI.
+      # options - The Hash option used to update the resource (default: {}). 
+      #           Check out the {http://dev.lelylan.com/rest/types/properties/#update API doc} for the accepted options.
+      # 
+      # Returns Hashie The updated property.
+      #
+      # Examples
+      # 
+      #   property = "http://api.lelylan.com/properties/4dcb9e23d033a9088902200a"
+      #   client.update_property(property, default: '100')
+      #
+      def update_property(property, options = {})
+        put("/properties/#{find_id(property)}", options)
+      end
+
+      # Public: Delete a property identified from its URI and returns extended information for it.
+      # Find more at {http://dev.lelylan.com/rest/types/properties/#delete Lelylan Dev Center}.
+      #
+      # property - A String that represent the property URI.
+      # 
+      # Returns Hashie The deleted property.
+      #
+      # Examples
+      # 
+      #   property = "http://api.lelylan.com/properties/4dcb9e23d033a9088902200a"
+      #   client.delete_property(property)
+      #
+      def delete_property(property)
+        delete("/properties/#{find_id(property)}")
+      end
+    end
+  end
+end
+
+

data/lib/lelylan/client/statuses.rb

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

data/lib/lelylan/client/types.rb

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