lelylan-rb 0.0.1

data/lib/lelylan/configuration.rb

@@ -0,0 +1,65 @@
+require 'faraday'
+require 'lelylan/version'
+
+module Lelylan
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :api_version,
+      :api_endpoint,
+      :web_endpoint,
+      :endpoint,
+      :user,
+      :password,
+      :proxy,
+      :token,
+      :user_agent,
+      :auto_traversal,
+      :per_page].freeze
+
+    DEFAULT_ADAPTER        = Faraday.default_adapter
+    DEFAULT_API_VERSION    = 0
+    DEFAULT_API_ENDPOINT   = 'http://api.lelylan.com/'
+    DEFAULT_WEB_ENDPOINT   = 'http://lelylan.com/'
+    DEFAULT_USER_AGENT     = "Lelylan Ruby Gem #{Lelylan::Version}".freeze
+    DEFAULT_AUTO_TRAVERSAL = false
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def api_endpoint=(value)
+      @api_endpoint = File.join(value, "")
+    end
+
+    def web_endpoint=(value)
+      @web_endpoint = File.join(value, "")
+    end
+
+    alias :endpoint= :api_endpoint=
+    alias :endpoint :api_endpoint
+
+    def reset
+      self.adapter        = DEFAULT_ADAPTER
+      self.api_version    = DEFAULT_API_VERSION
+      self.api_endpoint   = DEFAULT_API_ENDPOINT
+      self.web_endpoint   = DEFAULT_WEB_ENDPOINT
+      self.user           = nil
+      self.password       = nil
+      self.proxy          = nil
+      self.token          = nil
+      self.user_agent     = DEFAULT_USER_AGENT
+      self.auto_traversal = DEFAULT_AUTO_TRAVERSAL
+    end
+  end
+end

data/lib/lelylan/connection.rb

@@ -0,0 +1,33 @@
+require 'faraday_middleware'
+require 'faraday/response/raise_http_error'
+
+module Lelylan
+  module Connection
+    private
+
+    def connection(authenticate=true, raw=false, version=0, force_urlencoded=false)
+
+      options = {
+        :headers => {'Accept' => 'application/json', 'User-Agent' => user_agent, 'Content-Type' => 'application/json'},
+        :proxy => proxy,
+        :ssl => { :verify => false },
+        :url => Lelylan.api_endpoint
+      }
+
+      if authenticated?
+        self.token = token.refresh! if token.expired?
+        options[:headers].merge!('Authorization' => "Bearer #{token.token}") 
+      end
+
+      connection = Faraday.new(options) do |builder|
+        builder.request :json
+        builder.use Faraday::Response::RaiseHttpError
+        builder.use FaradayMiddleware::Mashify
+        builder.use FaradayMiddleware::ParseJson
+        builder.adapter(adapter)
+      end
+
+      connection
+    end
+  end
+end

data/lib/lelylan/error.rb

@@ -0,0 +1,34 @@
+module Lelylan
+  # Internal: Custom error class for rescuing from all Lelylan errors
+  class Error < StandardError; end
+
+  # Internal: Raised when Lelylan returns a 400 HTTP status code
+  class BadRequest < Error; end
+
+  # Internal: Raised when Lelylan returns a 401 HTTP status code
+  class Unauthorized < Error; end
+
+  # Internal: Raised when Lelylan returns a 403 HTTP status code
+  class Forbidden < Error; end
+
+  # Internal: Raised when Lelylan returns a 404 HTTP status code
+  class NotFound < Error; end
+
+  # Internal: Raised when Lelylan returns a 406 HTTP status code
+  class NotAcceptable < Error; end
+
+  # Internal: Raised when Lelylan returns a 422 HTTP status code
+  class UnprocessableEntity < Error; end
+
+  # Internal: Raised when Lelylan returns a 500 HTTP status code
+  class InternalServerError < Error; end
+
+  # Internal: Raised when Lelylan returns a 501 HTTP status code
+  class NotImplemented < Error; end
+
+  # Internal: Raised when Lelylan returns a 502 HTTP status code
+  class BadGateway < Error; end
+
+  # Internal: Raised when Lelylan returns a 503 HTTP status code
+  class ServiceUnavailable < Error; end
+end

data/lib/lelylan/request.rb

@@ -0,0 +1,70 @@
+require 'multi_json'
+
+module Lelylan
+  module Request
+
+    # Internal: Perform an HTTP DELETE request.
+    def delete(path, options={}, authenticate=true, raw=false, version=api_version, force_urlencoded=false)
+      request(:delete, path, options, authenticate, raw, version, force_urlencoded)
+    end
+
+    # Internal: Perform an HTTP GET request.
+    def get(path, options={}, authenticate=true, raw=false, version=api_version, force_urlencoded=false)
+      request(:get, path, options, authenticate, raw, version, force_urlencoded)
+    end
+
+    # Internal: Perform an HTTP PATCH request.
+    def patch(path, options={}, authenticate=true, raw=false, version=api_version, force_urlencoded=false)
+      request(:patch, path, options, authenticate, raw, version, force_urlencoded)
+    end
+
+    # Internal: Perform an HTTP POST request.
+    def post(path, options={}, authenticate=true, raw=false, version=api_version, force_urlencoded=false)
+      request(:post, path, options, authenticate, raw, version, force_urlencoded)
+    end
+
+    # Internal: Perform an HTTP PUT request.
+    def put(path, options={}, authenticate=true, raw=false, version=api_version, force_urlencoded=false)
+      request(:put, path, options, authenticate, raw, version, force_urlencoded)
+    end
+
+    # Internal: Gets the user requests limit.
+    def ratelimit
+      headers = get("/ratelimit",{}, true, true).headers
+      return headers["X-RateLimit-Limit"].to_i
+    end
+    alias rate_limit ratelimit
+
+    # Internal: Gets the remaining user requests.
+    def ratelimit_remaining
+      headers = get("/ratelimit",{}, api_version, true, true).headers
+      return headers["X-RateLimit-Remaining"].to_i
+    end
+    alias rate_limit_remaining ratelimit_remaining
+
+    private
+
+    # Internal: Perform the HTTP request.
+    #
+    # method - The Symbol representing the HTTP method.
+    # path - The String URI to call.
+    # options - The Hash options containing the params to send to the
+    #           service.
+    # authenticate - The Boolean value that authenticate the user.
+    # raw - The Boolean value let return the complete response. 
+    # force_urlencoded - The Boolean value that force the url encoding.
+    def request(method, path, options, authenticate, raw, version, force_urlencoded)
+      response = connection(authenticate, raw, version, force_urlencoded).send(method) do |request|
+        case method
+        when :delete, :get
+          request.url(path, options)
+        when :patch, :post, :put
+          request.url(path)
+          request.body = options unless options.empty?
+        end
+      end
+
+      raw ? response : response.body
+    end
+  end
+end

data/lib/lelylan/version.rb

@@ -0,0 +1,15 @@
+module Lelylan
+  class Version
+    MAJOR = 0 unless defined? MAJOR
+    MINOR = 0 unless defined? MINOR
+    PATCH = 1 unless defined? PATCH
+    PRE = nil unless defined? PRE
+
+    class << self
+
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+    end
+  end
+end

data/spec/faraday/response_spec.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+require 'helper'
+
+describe Faraday::Response do
+
+  let(:client) do
+    Lelylan::Client.new
+  end
+
+  {
+    400 => Lelylan::BadRequest,
+    401 => Lelylan::Unauthorized,
+    403 => Lelylan::Forbidden,
+    404 => Lelylan::NotFound,
+    406 => Lelylan::NotAcceptable,
+    422 => Lelylan::UnprocessableEntity,
+    500 => Lelylan::InternalServerError,
+    501 => Lelylan::NotImplemented,
+    502 => Lelylan::BadGateway,
+    503 => Lelylan::ServiceUnavailable,
+  }.each do |status, exception|
+
+    context "when HTTP status is #{status}" do
+
+      before do
+        stub_get('http://api.lelylan.com/devices').
+          to_return(:status => status)
+      end
+
+      it "should raise #{exception.name} error" do
+        expect do
+          client.devices
+        end.to raise_error(exception)
+      end
+    end
+  end
+end

data/spec/fixtures/categories.json

@@ -0,0 +1,7 @@
+[{
+    "uri": "http://www.example.com/categories/500425f5d033a9b4ac000003",
+    "id": "500425f5d033a9b4ac000003",
+    "name": "Lighting",
+    "created_at": "2012-07-16T14:32:21Z",
+    "updated_at": "2012-07-16T14:32:21Z"
+}]

data/spec/fixtures/category.json

@@ -0,0 +1,7 @@
+{
+    "uri": "http://www.example.com/categories/500425f8d033a9b4ac0000b1",
+    "id": "500425f8d033a9b4ac0000b1",
+    "name": "Lighting",
+    "created_at": "2012-07-16T14:32:24Z",
+    "updated_at": "2012-07-16T14:32:24Z"
+}

data/spec/fixtures/consumption.json

@@ -0,0 +1,11 @@
+{
+    "uri": "http://www.example.com/consumptions/5003c54dd033a96a3c0000fc",
+    "id": "5003c54dd033a96a3c0000fc",
+    "device": {
+        "uri": "http://www.example.com/devices/5003c54dd033a96a3c0000f8"
+    },
+    "type": "instantaneous",
+    "value": 125.0,
+    "unit": "kwh",
+    "occur_at": "2012-07-09T09:39:57+02:00"
+}

data/spec/fixtures/consumptions.json

@@ -0,0 +1,11 @@
+[{
+    "uri": "http://www.example.com/consumptions/5003c54ad033a96a3c00000b",
+    "id": "5003c54ad033a96a3c00000b",
+    "device": {
+        "uri": "http://www.example.com/devices/5003c54ad033a96a3c000007"
+    },
+    "type": "instantaneous",
+    "value": 125.0,
+    "unit": "kwh",
+    "occur_at": "2012-07-09T09:39:54+02:00"
+}]

data/spec/fixtures/device.json

@@ -0,0 +1,25 @@
+{
+    "uri": "http://www.example.com/devices/5003c611d033a96b96000271",
+    "id": "5003c611d033a96b96000271",
+    "name": "Closet dimmer",
+    "type": {
+        "uri": "https://type.lelylan.com/types/dimmer"
+    },
+    "properties": [{
+        "uri": "https://type.lelylan.com/properties/status",
+        "value": "off"
+    },
+    {
+        "uri": "https://type.lelylan.com/properties/intensity",
+        "value": "0.0"
+    }],
+    "physical": {
+        "uri": "https://node.lelylan.com/devices/physical-dimmer"
+    },
+    "pending": {
+        "uri": "http://www.example.com/devices/5003c611d033a96b96000271/pending",
+        "status": "false"
+    },
+    "created_at": "2012-07-16T09:43:13+02:00",
+    "updated_at": "2012-07-16T09:43:13+02:00"
+}

data/spec/fixtures/devices.json

@@ -0,0 +1,25 @@
+[{
+    "uri": "http://www.example.com/devices/5003c60ed033a96b96000009",
+    "id": "5003c60ed033a96b96000009",
+    "name": "Closet dimmer",
+    "type": {
+        "uri": "https://type.lelylan.com/types/dimmer"
+    },
+    "properties": [{
+        "uri": "https://type.lelylan.com/properties/status",
+        "value": "off"
+    },
+    {
+        "uri": "https://type.lelylan.com/properties/intensity",
+        "value": "0.0"
+    }],
+    "physical": {
+        "uri": "https://node.lelylan.com/devices/physical-dimmer"
+    },
+    "pending": {
+        "uri": "http://www.example.com/devices/5003c60ed033a96b96000009/pending",
+        "status": false
+    },
+    "created_at": "2012-07-16T09:43:10+02:00",
+    "updated_at": "2012-07-16T09:43:10+02:00"
+}]

data/spec/fixtures/function.json

@@ -0,0 +1,15 @@
+{
+    "uri": "http://www.example.com/functions/500425ffd033a9b4ac0002e5",
+    "id": "500425ffd033a9b4ac0002e5",
+    "name": "Set intensity",
+    "created_at": "2012-07-16T14:32:31Z",
+    "updated_at": "2012-07-16T14:32:31Z",
+    "properties": [{
+        "uri": "http://www.example.com/properties/status",
+        "value": "on"
+    },
+    {
+        "uri": "http://www.example.com/properties/intensity",
+        "value": "0"
+    }]
+}

data/spec/fixtures/functions.json

@@ -0,0 +1,15 @@
+[{
+    "uri": "http://www.example.com/functions/500425fbd033a9b4ac0000db",
+    "id": "500425fbd033a9b4ac0000db",
+    "name": "Set intensity",
+    "created_at": "2012-07-16T14:32:27Z",
+    "updated_at": "2012-07-16T14:32:27Z",
+    "properties": [{
+        "uri": "http://www.example.com/properties/status",
+        "value": "on"
+    },
+    {
+        "uri": "http://www.example.com/properties/intensity",
+        "value": "0"
+    }]
+}]

data/spec/fixtures/histories.json

@@ -0,0 +1,16 @@
+[{
+    "uri": "http://www.example.com/histories/5003c54fd033a96a3c0001a7",
+    "id": "5003c54fd033a96a3c0001a7",
+    "device": {
+        "uri": "http://www.example.com/devices/5003c54fd033a96a3c0001a3"
+    },
+    "properties": [{
+        "uri": "https://type.lelylan.com/properties/intensity",
+        "value": "100.0"
+    },
+    {
+        "uri": "https://type.lelylan.com/properties/status",
+        "value": "on"
+    }],
+    "created_at": "2012-07-09T09:39:59+02:00"
+}]

data/spec/fixtures/history.json

@@ -0,0 +1,16 @@
+{
+    "uri": "http://www.example.com/histories/5003c552d033a96a3c000398",
+    "id": "5003c552d033a96a3c000398",
+    "device": {
+        "uri": "http://www.example.com/devices/5003c552d033a96a3c000394"
+    },
+    "properties": [{
+        "uri": "https://type.lelylan.com/properties/intensity",
+        "value": "100.0"
+    },
+    {
+        "uri": "https://type.lelylan.com/properties/status",
+        "value": "on"
+    }],
+    "created_at": "2012-07-09T09:40:02+02:00"
+}

data/spec/fixtures/location.json

@@ -0,0 +1,55 @@
+{
+    "uri": "http://www.example.com/locations/1",
+    "id": "1",
+    "name": "Floor",
+    "type": "floor",
+    "created_at": "2012-07-16T17:04:14Z",
+    "updated_at": "2012-07-16T17:04:14Z",
+    "locations": {
+        "parent": {
+            "uri": "http://www.example.com/locations/2"
+        },
+        "children": [{
+            "uri": "http://www.example.com/locations/4"
+        }],
+        "ancestors": [{
+            "uri": "http://www.example.com/locations/3"
+        },
+        {
+            "uri": "http://www.example.com/locations/2"
+        }],
+        "descendants": [{
+            "uri": "http://www.example.com/locations/4"
+        },
+        {
+            "uri": "http://www.example.com/locations/5"
+        }]
+    },
+    "devices": {
+        "children": [{
+            "uri": {
+                "uri": "https://device.lelylan.com/devices/closet-dimmer"
+            }
+        },
+        {
+            "uri": {
+                "uri": "https://device.lelylan.com/devices/another-closet-dimmer"
+            }
+        }],
+        "descendants": [{
+            "uri": {
+                "uri": "https://device.lelylan.com/devices/closet-dimmer"
+            }
+        },
+        {
+            "uri": {
+                "uri": "https://device.lelylan.com/devices/another-closet-dimmer"
+            }
+        },
+        {
+            "uri": {
+                "uri": "https://device.lelylan.com/devices/descendant-closet-dimmer"
+            }
+        }]
+    }
+}