lelylan-rb 0.0.1 → 0.0.2

data/lib/lelylan/client/property.rb

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

data/lib/lelylan/client/status.rb

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

data/lib/lelylan/client/subscription.rb

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

data/lib/lelylan/client/type.rb

@@ -0,0 +1,73 @@
+module Lelylan
+  class Client
+    module Type
+
+      #
+      # 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 type(id)
+        get("/types/#{id}")
+      end
+
+      #
+      # Public: Returns a list of owned types.
+      #
+      # params - The Hash used to refine the search (default: {}).
+      #
+      # Returns Array List of types.
+      #
+      def types(params = {})
+        get('/types', params)
+      end
+
+      #
+      # Public: Returns a list of all existing types.
+      #
+      # params - The Hash used to refine the search (default: {}).
+      #
+      # Returns Array List of types.
+      #
+      def public_types(params = {})
+        get('/types/public', params)
+      end
+
+      #
+      # Public: Create a type and returns extended information for it.
+      #
+      # params - The Hash used to create the resource (default: {}).
+      #
+      # Returns Hashie The created type.
+      #
+      def create_type(params = {})
+        post('/types', params)
+      end
+
+      #
+      # Public: Update a type identified from its ID and returns extended information for it.
+      #
+      # id - A String that represent the type ID.
+      # params - The Hash used to update the resource (default: {}).
+      #
+      # Returns Hashie The updated type.
+      #
+      def update_type(id, params = {})
+        put("/types/#{id}", params)
+      end
+
+      #
+      # Public: Delete a type identified from its ID and returns extended information for it.
+      #
+      # id - A String that represent the type ID.
+      #
+      # Returns Hashie The deleted type.
+      #
+      def delete_type(id)
+        delete("/types/#{id}")
+      end
+    end
+  end
+end

data/lib/lelylan/configuration.rb

@@ -9,8 +9,8 @@ module Lelylan
       :api_endpoint,
       :web_endpoint,
       :endpoint,
-      :user,
-      :password,
+      :client_id,
+      :client_secret,
       :proxy,
       :token,
       :user_agent,
@@ -54,8 +54,8 @@ module Lelylan
       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.client_id      = nil
+      self.client_secret  = nil
       self.proxy          = nil
       self.token          = nil
       self.user_agent     = DEFAULT_USER_AGENT

data/lib/lelylan/connection.rb

@@ -1,3 +1,4 @@
+require 'base64'
 require 'faraday_middleware'
 require 'faraday/response/raise_http_error'
 
@@ -5,7 +6,7 @@ module Lelylan
   module Connection
     private
 
-    def connection(authenticate=true, raw=false, version=0, force_urlencoded=false)
+    def connection(authenticate=true, raw=false, version=0, force_urlencoded=false, path='')
 
       options = {
         :headers => {'Accept' => 'application/json', 'User-Agent' => user_agent, 'Content-Type' => 'application/json'},
@@ -16,7 +17,13 @@ module Lelylan
 
       if authenticated?
         self.token = token.refresh! if token.expired?
-        options[:headers].merge!('Authorization' => "Bearer #{token.token}") 
+        options[:headers].merge!('Authorization' => "Bearer #{token.token}")
+      end
+
+      if path =~ /subscriptions/
+        raise Lelylan::Error, 'To make a request to the realtime services you need both client id and client secret' if (!client_id or !client_secret) and path =~ /subscriptions/
+        basic = Base64.encode64("#{self.client_id}:#{self.client_secret}")
+        options[:headers].merge!('Authorization' => "Bearer #{basic}")
       end
 
       connection = Faraday.new(options) do |builder|

data/lib/lelylan/request.rb

@@ -28,20 +28,6 @@ module Lelylan
       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.
@@ -51,10 +37,10 @@ module Lelylan
     # 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. 
+    # 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|
+      response = connection(authenticate, raw, version, force_urlencoded, path).send(method) do |request|
         case method
         when :delete, :get
           request.url(path, options)

data/lib/lelylan/version.rb

@@ -2,7 +2,7 @@ module Lelylan
   class Version
     MAJOR = 0 unless defined? MAJOR
     MINOR = 0 unless defined? MINOR
-    PATCH = 1 unless defined? PATCH
+    PATCH = 2 unless defined? PATCH
     PRE = nil unless defined? PRE
 
     class << self

data/spec/fixtures/profile.json

@@ -0,0 +1,8 @@
+{
+  "id": "5036227a4f1b030200009000",
+  "email": "reggie@lelylan.com",
+  "full_name": "Reggie",
+  "homepage": "http://lelylan.com",
+  "location": "New York",
+  "rate_limit": 5000
+}

data/spec/fixtures/subscription.json

@@ -0,0 +1,10 @@
+{
+  "uri": "http://api.lelylan.com/subscriptions/508acdffd033a9ea77000026",
+  "id": "508acdffd033a9ea77000026",
+  "client": { "uri": "http://people.lelylan.com/oauth/applications/508acdffd033a9ea77025" },
+  "resource": "devices",
+  "event": "property-update",
+  "callback_uri": "http://callback.com/lelylan",
+  "created_at": "2012-10-26T17:53:03Z",
+  "updated_at": "2012-10-26T17:53:03Z"
+}

data/spec/fixtures/subscriptions.json

@@ -0,0 +1,10 @@
+[{
+  "uri": "http://api.lelylan.com/subscriptions/508acdffd033a9ea77000026",
+  "id": "508acdffd033a9ea77000026",
+  "client": { "uri": "http://people.lelylan.com/oauth/applications/508acdffd033a9ea77025" },
+  "resource": "devices",
+  "event": "property-update",
+  "callback_uri": "http://callback.com/lelylan",
+  "created_at": "2012-10-26T17:53:03Z",
+  "updated_at": "2012-10-26T17:53:03Z"
+}]

data/spec/lelylan/client/device_spec.rb

@@ -0,0 +1,234 @@
+require 'helper'
+
+describe Lelylan::Client::Device do
+
+  let(:lelylan) do
+    a_client
+  end
+
+  describe '#device' do
+
+    before do
+      stub_get('/devices/1').to_return(body: fixture('device.json'))
+    end
+
+    let!(:device) do
+      lelylan.device('1')
+    end
+
+    it 'returns the device' do
+      device.id.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_get('/devices/1').should have_been_made
+    end
+  end
+
+
+  describe '#device_privates' do
+
+    before do
+      stub_get('/devices/1/privates').to_return(body: fixture('device.json'))
+    end
+
+    let!(:device) do
+      lelylan.device_privates('1')
+    end
+
+    it 'returns the device' do
+      device.id.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_get('/devices/1/privates').should have_been_made
+    end
+  end
+
+
+  describe '#devices' do
+
+    before do
+      stub_get('/devices').to_return(body: fixture('devices.json'))
+    end
+
+    let!(:devices) do
+      lelylan.devices
+    end
+
+    it 'returns a list of devices' do
+      devices.should have(1).item
+    end
+
+    it 'sends the request' do
+      a_get('/devices').should have_been_made
+    end
+
+    context 'with params' do
+
+      before do
+        stub_get('/devices').with(query: { per: '25' }).to_return(body: fixture('device.json'))
+      end
+
+      before do
+        lelylan.devices(per: 25)
+      end
+
+      it 'sends the params' do
+        a_get('/devices').with(query: { per: '25' }).should have_been_made
+      end
+    end
+  end
+
+
+  describe '#create_device' do
+
+    before do
+      stub_post('/devices').with(body: {name: 'Dimmer'}).to_return(body: fixture('device.json'))
+    end
+
+    let!(:device) do
+      lelylan.create_device(name: 'Dimmer')
+    end
+
+    it 'returns the device' do
+      device.id.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_post('/devices').with(body: {name: 'Dimmer'}).should have_been_made
+    end
+  end
+
+
+  describe '#update_device' do
+
+    before do
+      stub_put('/devices/1').with(body: {name: 'Dimmer'}).to_return(body: fixture('device.json'))
+    end
+
+    let!(:device) do
+      lelylan.update_device('1', name: 'Dimmer')
+    end
+
+    it 'returns the device' do
+      device.id.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_put('/devices/1').with(body: {name: 'Dimmer'}).should have_been_made
+    end
+  end
+
+
+  describe '#delete_device' do
+
+    before do
+      stub_delete('/devices/1').to_return(body: fixture('device.json'))
+    end
+
+    let!(:device) do
+      lelylan.delete_device('1')
+    end
+
+    it 'returns the device' do
+      device.id.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_delete('/devices/1').should have_been_made
+    end
+  end
+
+
+  describe '#execute' do
+
+    let(:function) do
+      'http://api.lelylan.com/functions/4dcb9e23d033a9088900020a'
+    end
+
+    let(:properties) do
+      [ { uri: 'http://api.lelylan.com/properties/4dcb9e23d033a9088900020a', value: '50' } ]
+    end
+
+    before do
+      stub_put('/devices/1/functions').with(body: { properties: properties, function: function }).to_return(body: fixture('device.json'))
+    end
+
+    let!(:device) do
+      lelylan.execute('1', { function: function, properties: properties })
+    end
+
+    it 'returns the updated device' do
+      device.id.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_put('/devices/1/functions').with(body: { properties: properties, function: function }).should have_been_made
+    end
+  end
+
+
+  describe '#device_properties' do
+
+    let(:properties) do
+      [{uri: 'http://api.lelylan.com/properties/4dcb9e23d033a9088900020a', value: '50'}]
+    end
+
+    before do
+      stub_put("/devices/1/properties").with(body: { properties: properties }).to_return(body: fixture('device.json'))
+    end
+
+    let!(:device) do
+      lelylan.device_properties('1', properties: properties)
+    end
+
+    it 'returns the updated device' do
+      device.id.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_put('/devices/1/properties').with(body: { properties: properties }).should have_been_made
+    end
+  end
+
+
+  describe '#activate_device' do
+
+    before do
+      stub_post('/activations').with(body: { activation_code: '1' }).to_return(body: fixture('device.json'))
+    end
+
+    let!(:device) do
+      lelylan.activate_device(activation_code: '1')
+    end
+
+    it 'returns the device' do
+      device.id.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_post('/activations').with(body: { activation_code: '1' }).should have_been_made
+    end
+  end
+
+
+  describe '#deactivate_device' do
+
+    before do
+      stub_delete('/activations/1').to_return(body: fixture('device.json'))
+    end
+
+    let!(:device) do
+      lelylan.deactivate_device('1')
+    end
+
+    it 'returns the device' do
+      device.id.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_delete('/activations/1').should have_been_made
+    end
+  end
+end