lelylan-rb 0.0.1 → 0.0.2

data/javascripts/main.js

@@ -0,0 +1 @@
+console.log('This would be the main JS file.');

data/lelylan_rb.gemspec

@@ -2,35 +2,34 @@
 require File.expand_path('../lib/lelylan/version', __FILE__)
 
 Gem::Specification.new do |gem|
+
+  gem.authors = ["Andrea Reginato"]
+  gem.description = %q{Ruby wrapper for Lelylan API}
+  gem.email = ['touch@lelylan.com']
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/lelylan/lelylan-rb'
+  gem.name = 'lelylan-rb'
+  gem.version = Lelylan::Version
+
   gem.add_dependency 'addressable', '~> 2.2'
   gem.add_dependency 'oauth2', '~> 0.8'
   gem.add_dependency 'faraday', '~> 0.8'
   gem.add_dependency 'faraday_middleware', '~> 0.8'
   gem.add_dependency 'hashie', '~> 1.2'
   gem.add_dependency 'multi_json', '~> 1.3'
+
   gem.add_development_dependency 'json'
-  gem.add_development_dependency 'maruku'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'guard-rspec'
   gem.add_development_dependency 'fuubar'
   gem.add_development_dependency 'growl'
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'yard-tomdoc'
-  gem.add_development_dependency 'redcarpet'
-  gem.add_development_dependency 'github-markup'
-  gem.authors = ["Andrea Reginato"]
-  gem.description = %q{Ruby wrapper for Lelylan API}
-  gem.email = ['touch@lelylan.com']
-  gem.files = `git ls-files`.split("\n")
-  gem.homepage = 'https://github.com/lelylan/lelylan-rb'
-  gem.name = 'lelylan-rb'
+  gem.add_development_dependency 'rb-fsevent'
+
   gem.platform = Gem::Platform::RUBY
   gem.require_paths = ['lib']
   gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
   gem.summary = gem.description
   gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.version = Lelylan::Version
 end

data/lib/lelylan/client.rb

@@ -2,15 +2,16 @@ require 'lelylan/authentication'
 require 'lelylan/connection'
 require 'lelylan/request'
 
-require 'lelylan/client/devices'
-require 'lelylan/client/consumptions'
-require 'lelylan/client/histories'
-require 'lelylan/client/types'
-require 'lelylan/client/properties'
-require 'lelylan/client/functions'
-require 'lelylan/client/statuses'
-require 'lelylan/client/categories'
-require 'lelylan/client/locations'
+require 'lelylan/client/profile'
+require 'lelylan/client/device'
+require 'lelylan/client/history'
+require 'lelylan/client/type'
+require 'lelylan/client/property'
+require 'lelylan/client/function'
+require 'lelylan/client/status'
+require 'lelylan/client/location'
+require 'lelylan/client/subscription'
+require 'lelylan/client/physical'
 
 module Lelylan
   class Client
@@ -23,25 +24,21 @@ module Lelylan
       end
     end
 
-    # helper method
-    def find_id(uri)
-      Addressable::URI.parse(uri).basename
-    end
-
     # structure related
     include Lelylan::Authentication
     include Lelylan::Connection
     include Lelylan::Request
 
     # client related
-    include Lelylan::Client::Devices
-    include Lelylan::Client::Consumptions
-    include Lelylan::Client::Histories
-    include Lelylan::Client::Types
-    include Lelylan::Client::Properties
-    include Lelylan::Client::Functions
-    include Lelylan::Client::Statuses
-    include Lelylan::Client::Categories
-    include Lelylan::Client::Locations
+    include Lelylan::Client::Profile
+    include Lelylan::Client::Device
+    include Lelylan::Client::History
+    include Lelylan::Client::Type
+    include Lelylan::Client::Property
+    include Lelylan::Client::Function
+    include Lelylan::Client::Status
+    include Lelylan::Client::Location
+    include Lelylan::Client::Subscription
+    include Lelylan::Client::Physical
   end
 end

data/lib/lelylan/client/device.rb

@@ -0,0 +1,121 @@
+module Lelylan
+  class Client
+    module Device
+
+      #
+      # Public: Returns extended information for a given device identified from its ID.
+      #
+      # id - A String that represent the device ID.
+      #
+      # Returns Hashie The device.
+      #
+      def device(id)
+        get("/devices/#{id}")
+      end
+
+      #
+      # Public: Returns extended information for a given device identified from its ID.
+      #
+      # id - A String that represent the device ID.
+      #
+      # Returns Hashie The device.
+      #
+      def device_privates(id)
+        get("/devices/#{id}/privates")
+      end
+
+      #
+      # Public: Returns a list of owned devices.
+      #
+      # params - The Hash used to refine the search (default: {}).
+      #
+      # Returns Array List of devices.
+      #
+      def devices(params = {})
+        get('/devices', params)
+      end
+
+      #
+      # Public: Create a device and returns extended information for it.
+      #
+      # params - The Hash used to create the resource (default: {}).
+      #
+      # Returns Hashie The created device.
+      #
+      def create_device(params = {})
+        post('/devices', params)
+      end
+
+      #
+      # Public: Update a device identified from its ID and returns extended information for it.
+      #
+      # id - A String that represent the device ID.
+      # params - The Hash used to update the resource (default: {}).
+      #
+      # Returns Hashie The updated device.
+      #
+      def update_device(id, params = {})
+        put("/devices/#{id}", params)
+      end
+
+      #
+      # Public: Delete a device identified from its ID and returns extended information for it.
+      #
+      # id - A String that represent the device ID.
+      #
+      # Returns Hashie The deleted device.
+      #
+      def delete_device(id)
+        delete("/devices/#{id}")
+      end
+
+      #
+      # Public: Execute a function on a device identified from its ID and returns
+      # extended information for it.
+      #
+      # id - A String that represent the device ID.
+      # params - An Hash containing the function to execute and the device properties.
+      #
+      # Returns Hashie The device with the updated properties.
+      #
+      def execute(id, params={})
+        put("/devices/#{id}/functions", params)
+      end
+
+      #
+      # Public: Update properties on a device identified from its ID and returns
+      # extended information for it.
+      #
+      # id - A String that represent the device ID.
+      # params - An Hash containing the device properties.
+      #
+      # Returns Hashie The device with the updated properties.
+      #
+      def device_properties(id, params={})
+        put("/devices/#{id}/properties", params)
+      end
+
+      #
+      # Public: Activate a device and returns extended information for it.
+      #
+      # params - A Hash containing the activation code.
+      #
+      # Returns Hashie The activated device.
+      #
+      def activate_device(params = {})
+        post('/activations', params)
+      end
+
+      #
+      # Public: Deactivate a device and returns extended information for it.
+      #
+      # activation_code - A String that represents the activation_code.
+      #
+      # Returns Hashie The activated device.
+      #
+      def deactivate_device(activation_code)
+        delete("/activations/#{activation_code}")
+      end
+    end
+  end
+end

data/lib/lelylan/client/function.rb

@@ -0,0 +1,73 @@
+module Lelylan
+  class Client
+    module Function
+
+      #
+      # Public: Returns extended information for a given function identified from its ID.
+      #
+      # id - A String that represent the function ID.
+      #
+      # Returns Hashie The function.
+      #
+      def function(id)
+        get("/functions/#{id}")
+      end
+
+      #
+      # Public: Returns a list of owned functions.
+      #
+      # params - The Hash used to refine the search (default: {}).
+      #
+      # Returns Array List of functions.
+      #
+      def functions(params = {})
+        get('/functions', params)
+      end
+
+      #
+      # Public: Returns a list of all existing functions.
+      #
+      # params - The Hash used to refine the search (default: {}).
+      #
+      # Returns Array List of functions.
+      #
+      def public_functions(params = {})
+        get('/functions/public', params)
+      end
+
+      #
+      # Public: Create a function and returns extended information for it.
+      #
+      # params - The Hash used to create the resource (default: {}).
+      #
+      # Returns Hashie The created function.
+      #
+      def create_function(params = {})
+        post('/functions', params)
+      end
+
+      #
+      # Public: Update a function identified from its ID and returns extended information for it.
+      #
+      # id - A String that represent the function ID.
+      # params - The Hash used to update the resource (default: {}).
+      #
+      # Returns Hashie The updated function.
+      #
+      def update_function(id, params = {})
+        put("/functions/#{id}", params)
+      end
+
+      #
+      # Public: Delete a function identified from its ID and returns extended information for it.
+      #
+      # id - A String that represent the function ID.
+      #
+      # Returns Hashie The deleted function.
+      #
+      def delete_function(id)
+        delete("/functions/#{id}")
+      end
+    end
+  end
+end

data/lib/lelylan/client/history.rb

@@ -0,0 +1,28 @@
+module Lelylan
+  class Client
+    module History
+
+      #
+      # Public: Returns extended information for a given history identified from its ID.
+      #
+      # id - A String that represent the history ID.
+      #
+      # Returns Hashie The history.
+      #
+      def find_history(id)
+        get("/histories/#{id}")
+      end
+
+      #
+      # Public: Returns a list of histories related to owned devices.
+      #
+      # params - The Hash used to refine the search (default: {}).
+      #
+      # Returns Array List of histories.
+      #
+      def all_histories(params = {})
+        get('/histories', params)
+      end
+    end
+  end
+end

data/lib/lelylan/client/location.rb

@@ -0,0 +1,62 @@
+module Lelylan
+  class Client
+    module Location
+
+      #
+      # Public: Returns extended information for a given location identified from its ID.
+      #
+      # id - A String that represent the location ID.
+      #
+      # Returns Hashie The location.
+      #
+      def location(id)
+        get("/locations/#{id}")
+      end
+
+      #
+      # Public: Returns a list of owned locations.
+      #
+      # params - The Hash used to refine the search (default: {}).
+      #
+      # Returns Array List of locations.
+      #
+      def locations(params = {})
+        get('/locations', params)
+      end
+
+      #
+      # Public: Create a location and returns extended information for it.
+      #
+      # params - The Hash used to create the resource (default: {}).
+      #
+      # Returns Hashie The created location.
+      #
+      def create_location(params = {})
+        post('/locations', params)
+      end
+
+      #
+      # Public: Update a location identified from its ID and returns extended information for it.
+      #
+      # id - A String that represent the location ID.
+      # params - The Hash used to update the resource (default: {}).
+      #
+      # Returns Hashie The updated location.
+      #
+      def update_location(id, params = {})
+        put("/locations/#{id}", params)
+      end
+
+      #
+      # Public: Delete a location identified from its ID and returns extended information for it.
+      #
+      # id - A String that represent the location ID.
+      #
+      # Returns Hashie The deleted location.
+      #
+      def delete_location(id)
+        delete("/locations/#{id}")
+      end
+    end
+  end
+end

data/lib/lelylan/client/physical.rb

@@ -0,0 +1,34 @@
+require 'uri'
+require 'openssl'
+require 'securerandom'
+require 'json'
+require 'lelylan/authentication'
+
+module Lelylan
+  class Client
+    module Physical
+
+      #
+      # Public: Send a request adding a nonce and a X-Physical-Signature
+      # header.
+      #
+      # uri - A String that represents the uri of the physical device.
+      # secret - The device secret.
+      # params - An object containing the JSON params to send.
+      #
+      # Returns Hashie The JSON resource.
+      #
+      def physical_properties(uri, secret, params)
+        params[:nonce] = SecureRandom.uuid if not params[:nonce]
+
+        digest    = OpenSSL::Digest::Digest.new('sha1')
+        signature = OpenSSL::HMAC.hexdigest(digest, secret, params.to_json.to_s)
+        headers   = { 'X-Physical-Signature' => signature, 'Content-Type' => 'application/json' }
+
+        request  = Faraday.new
+        response = request.put(uri, params, headers)
+        response.body
+      end
+    end
+  end
+end

data/lib/lelylan/client/profile.rb

@@ -0,0 +1,17 @@
+module Lelylan
+  class Client
+    module Profile
+
+      #
+      # Public: Returns extended information for a given type identified from its ID.
+      #
+      # id - A String that represent the type ID.
+      #
+      # Returns Hashie The type.
+      #
+      def me()
+        get('/me')
+      end
+    end
+  end
+end