lelylan-rb 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.0.4 (January 26, 2013)
+
+* Full support to error handling
+* Fixed physical device request
+* Fixed HTTP Basic Authentication system for subscription services
+* Made some extra tests to check the fact that delete services are
+  correctly working
+
 ## v0.0.3 (January 25, 2013)
 
 * Added content lenght 0 for all DELETE requests

data/README.md

@@ -53,8 +53,10 @@ related documentation in the [dev center](http://dev.lelylan.com/api/oauth#langu
 oauth = OAuth2::Client.new(client_id, client_secret, site: site)
 
 # Redirect the application to the Lelylan authorization page
-redirect oauth.auth_code.authorize_url(redirect_uri: redirect_uri)
-# => http://people.lelylan.com/oauth/authorize?redirect_uri=http://localhost:3000/callback&scope=devices&response_type=code&client_id=<client-id>
+redirect oauth.auth_code.authorize_url(redirect_uri: redirect_uri, scope: scope)
+# => http://people.lelylan.com/oauth/authorize?
+#      redirect_uri=http://localhost:3000/callback&
+#      scope=<scope>&response_type=code&client_id=<client-id>
 
 # Get the access token object (authorization code is given from the previous step)
 token = oauth.auth_code.get_token(params[:code], redirect_uri: redirect_uri)
@@ -69,8 +71,12 @@ following example shows how to print in the console a list of owned devices.
 # Initialize Lelylan client
 lelylan = Lelylan::Client.new(token: token)
 
-# Get the first device where the name matches with Dimmer
+# Get the first device where the name matches with Dimmer.
 device = lelylan.devices(name: 'Dimmer').first
+
+# The client returns an Hashie (https://github.com/intridea/hashie)
+puts device.uri # get the device uri
+puts device.properties.first.value # get the first device property value
 ```
 
 ### Realtime services
@@ -83,106 +89,87 @@ lelylan = Lelylan::Client.new(client_id:'<client-id>', client_secret: '<client-s
 subscriptions = lelylan.subscriptions
 ```
 
-## Authorization flows
-
-Lelylan support three OAuth2 authorization flows.
-
-### Authorization code flows
-
-```ruby
-oauth = OAuth2::Client.new(client_id, client_secret, site: site)
-redirect oauth.auth_code.authorize_url(redirect_uri: redirect_uri)
-token = oauth.auth_code.get_token(params[:code], redirect_uri: redirect_uri)
-```
-
-### Implicit grant flow
-
-```ruby
-oauth = OAuth2::Client.new(client_id, client_secret, site: site)
-redirect oauth.auth_code.authorize_url(redirect_uri: redirect_uri)
-token = OAuth2::AccessToken.from_kvform(client, params)
-```
+### Implemented Services
 
-### Resource owner password credentials flow
-
-```ruby
-oauth = OAuth2::Client.new(client_id, client_secret, site: site)
-token = oauth.password.get_token('email', 'password')
-```
-
-Access tokens, when expired, are automatically refreshed.
-
-
-## Lelylan Services
-
-### Devices
-
-The Device API defines a set of services to monitor and control every existing device.
-Its final goal is to map every device to a unique URI which provides control over it.
+**Devices** - The Device API defines a set of services to monitor and control every existing
+device. Its final goal is to map every device to a unique URI which provides control over it.
 [See examples](http://dev.lelylan.com/api/devices#ruby).
 
-### Histories
+**Activations** - Easy way to move the device ownership between people.
+[See examples](http://dev.lelylan.com/api/devices#ruby).
 
-When a device updates its properties or executes a function a new history resource with
-a snapshot of all device properties is created by Lelylan, also the ones that has not been
-updated. This makes it easy to recreate previous device status and extract usage patterns
-to improve the way people live their house.
+**Histories** - When a device updates its properties or executes a function a new history
+resource with a snapshot of all device properties is created by Lelylan, also the ones that
+has not been updated. This makes it easy to recreate previous device status and extract usage
+patterns to improve the way people live their house.
 [See examples](http://dev.lelylan.com/api/devices/histories#ruby).
 
-### Types
-
-A type describes the structure of a device. In its simplest form every type can be defined
-as the combination of three key elements: properties (what vary during time), functions
+**Types** - A type describes the structure of a device. In its simplest form every type can be
+defined as the combination of three key elements: properties (what vary during time), functions
 (what a device can do), statuses (what a device is in a specific time of its life).
 [See examples](http://dev.lelylan.com/api/types#ruby).
 
-### Properties
-
-A property is whatever vary in a device during time. It can be the intensity in a dimmer,
-the temperature in a cooling system or the volume in a television.
+**Properties** - A property is whatever vary in a device during time. It can be the intensity in
+a dimmer, the temperature in a cooling system or the volume in a television.
 [See examples](http://dev.lelylan.com/api/types/properties#ruby).
 
-### Functions
-
-Functions defines the daily interactions you have with the devices in your house, for
-example when you turn on a light, close a door or raise the temperature in a room.
+**Functions** - Functions defines the daily interactions you have with the devices in your house,
+for example when you turn on a light, close a door or raise the temperature in a room.
 With functions you can control any device in the same way you do everyday of your life.
 [See examples](http://dev.lelylan.com/api/types/functions#ruby).
 
-### Statuses
-
-Properties are not always enough to describe the status of a device. Think at a roller
+**Statuses** - Properties are not always enough to describe the status of a device. Think at a roller
 shutter for example. It has the property aperture that is 100 when open or 0 when closed.
 But what if the roller shutter is opening? It is nether open or close. To have a complete
 control over the device status in a specific moment of its life is to use the status API.
 [See examples](http://dev.lelylan.com/api/types/statuses#ruby).
 
-### Locations
-
-Locations are the places we live in and where physical devices are placed. Lelylan identifies
+**Locations** - Locations are the places we live in and where physical devices are placed. Lelylan identifies
 three types of locations usually organized in a hierarchical structure: houses, floors and
 rooms.
 [See examples](http://dev.lelylan.com/api/locations#ruby).
 
-### Physical devices
-
-Physical devices are the real objects you physically interact with everyday of your life
+**Physical Devices** - Physical devices are the real objects you physically interact with everyday of your life
 like lights, appliances, alarms and more. To enable the communication between Lelylan and
 physical devices they should provide a simple set of web services.
 [See examples](http://dev.lelylan.com/api/physicals#ruby).
 
-### Subscriptions
-
-Get real-time updates by subscribing to a resource and its related event.
+**Subscriptions** - Get realtime updates by subscribing to a resource and its related event.
 [See examples](http://dev.lelylan.com/api/realtime#ruby).
 
-### Authenticated User Profile
-
-Returns extended information for the authenticated user.
+**User Profile** - Returns extended information for the authenticated user.
 [See examples](http://dev.lelylan.com/api/core#get-a-user-ruby).
 
 
-## Errors
+### Authorization flows
+
+#### Authorization code flows
+
+```ruby
+oauth = OAuth2::Client.new(client_id, client_secret, site: site)
+redirect oauth.auth_code.authorize_url(redirect_uri: redirect_uri)
+token = oauth.auth_code.get_token(params[:code], redirect_uri: redirect_uri)
+```
+
+#### Implicit grant flow
+
+```ruby
+oauth = OAuth2::Client.new(client_id, client_secret, site: site)
+redirect oauth.auth_code.authorize_url(redirect_uri: redirect_uri)
+token = OAuth2::AccessToken.from_kvform(client, params)
+```
+
+#### Resource owner password credentials flow
+
+```ruby
+oauth = OAuth2::Client.new(client_id, client_secret, site: site)
+token = oauth.password.get_token('email', 'password')
+```
+
+Access tokens, when expired, are automatically refreshed.
+
+
+### Errors
 
 Exceptions are raised when a 4xx or 5xx status code is returned.
 
@@ -199,18 +186,21 @@ Through the error message attribute you can access the error information.
 
 ```ruby
 begin
-  @type = Lelylan::Type.type("https://type.lelylan.com/types/wrong")
+  device = lelylan.device('<id>')
 rescue Lelylan::Error => e
-  puts "The resource #{e.message.error.uri} was not found"
+  puts e.message
 end
 ```
 
+Unluckily the `#message` method can only be a string. For this reason we
+can't return a JSON structure when lelylan offers it, but we return the
+`error.description` value.
 Learn more about the [error response structure](http://dev.lelylan.com/api/core#errors).
 
 
-## Configurations
+### Configurations
 
-### API endpoint
+#### API endpoint
 
 Configuration block.
 
@@ -242,24 +232,34 @@ provide specs to your contribution.
 * Run `bundle install` for dependencies.
 * Run `bundle exec guard` and press enter to execute all specs.
 
+### Running locally
+
+Whenever you want to use the source code from your IRB session simply import `lib/`.
+
+```
+$ git clone https://github.com/lelylan/lelylan-rb
+$ cd lelylan-rb
+$ irb -I lib/
+$ > require 'lelylan'
+```
 
-## Spec guidelines
+### Spec guidelines
 
 Follow [rspec best practices](http://betterspecs.org) guidelines.
 
 
-## Coding guidelines
+### Coding guidelines
 
 Follow [github](https://github.com/styleguide/) guidelines.
 
 
-## Feedback
+### Feedback
 
 Use the [issue tracker](http://github.com/lelylan/lelylan-rb/issues) for bugs.
 [Mail](mailto:touch@lelylan.com) or [Tweet](http://twitter.com/lelylan) us for any idea that can improve the project.
 
 
-## Links
+### Links
 
 * [GIT Repository](http://github.com/lelylan/lelylan-rb)
 * [Lelylan Ruby Website](http://lelylan.github.com/lelylan-rb).

data/lelylan_rb.gemspec

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require File.expand_path('../lib/lelylan/version', __FILE__)
+require File.expand_path('./../lib/lelylan/version', __FILE__)
 
 Gem::Specification.new do |gem|
 

data/lib/faraday/response/raise_http_error.rb

@@ -1,5 +1,5 @@
 require 'faraday'
-require 'multi_json'
+require 'hashie'
 
 module Faraday
   class Response::RaiseHttpError < Response::Middleware
@@ -29,7 +29,14 @@ module Faraday
     end
 
     def error_message(response)
-      response[:body]
+      body = response[:body] || ''
+
+      begin
+        body = Hashie::Mash.new(JSON.parse(response[:body]))
+      rescue
+      end
+
+      body.is_a?(::Hashie::Mash) ? body.error.description : body
     end
   end
 end

data/lib/lelylan/client/physical.rb

@@ -23,10 +23,18 @@ module Lelylan
 
         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' }
+        headers   = { 'X-Physical-Signature' => signature }
+
+        request  = Faraday.new do |builder|
+          builder.request :json
+          builder.use Faraday::Response::RaiseHttpError
+          builder.use FaradayMiddleware::Mashify
+          builder.use FaradayMiddleware::ParseJson
+          builder.adapter(adapter)
+        end
 
-        request  = Faraday.new
         response = request.put(uri, params, headers)
+
         response.body
       end
     end

data/lib/lelylan/connection.rb

@@ -6,7 +6,7 @@ module Lelylan
   module Connection
     private
 
-    def connection(authenticate=true, raw=false, version=0, force_urlencoded=false, path='', method)
+    def connection(method='get', path='', authenticate=true, raw=false, version=0, force_urlencoded=false)
 
       options = {
         :headers => {'Accept' => 'application/json', 'User-Agent' => user_agent, 'Content-Type' => 'application/json'},
@@ -22,17 +22,18 @@ module Lelylan
 
       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
 
-      options[:headers].merge!('Content-Length' => '0') if method == :delete
+      if method == :delete
+        options[:headers].merge!('Content-Length' => '0')
+      end
 
       connection = Faraday.new(options) do |builder|
         builder.request :json
-        builder.use Faraday::Response::RaiseHttpError
+        builder.use Faraday::Request::BasicAuthentication, self.client_id, self.client_secret if path =~ /subscriptions/
         builder.use FaradayMiddleware::Mashify
         builder.use FaradayMiddleware::ParseJson
+        builder.use Faraday::Response::RaiseHttpError
         builder.adapter(adapter)
       end
 

data/lib/lelylan/request.rb

@@ -40,7 +40,7 @@ module Lelylan
     # 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, path).send(method) do |request|
+      response = connection(method, path, authenticate, raw, version, force_urlencoded).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 = 3 unless defined? PATCH
+    PATCH = 4 unless defined? PATCH
     PRE = nil unless defined? PRE
 
     class << self

data/spec/fixtures/errors/401.json

@@ -0,0 +1,9 @@
+{
+  "status": 401,
+  "method": "POST",
+  "request": "http://api.lelylan.com/devices/4f4bb686d033a957c1000251",
+  "error": {
+    "code": "notifications.access.not_authorized",
+    "description": "Token not valid"
+  }
+}

data/spec/fixtures/errors/404.json

@@ -0,0 +1,10 @@
+{
+  "status": 404,
+  "method": "GET",
+  "request": "http://api.lelylan.com/devices/4f4ba959d033a95549000261",
+  "error": {
+    "code": "notifications.resource.not_found",
+    "description": "Resource not found",
+    "uri": "http://api.lelylan.com/devices/4f4ba959d033a95549000261"
+  }
+}

data/spec/fixtures/errors/422.json

@@ -0,0 +1,10 @@
+{
+  "status": 422,
+  "method": "POST",
+  "request": "http://api.lelylan.com/devices",
+  "error": {
+    "code": "notifications.resource.not_valid",
+    "description": "Name can't be blank.",
+    "body": { "name": "" }
+  }
+}

data/spec/lelylan/client/physical_spec.rb

@@ -9,7 +9,7 @@ describe Lelylan::Client::Type do
   describe '#physical_properties' do
 
     before do
-      stub_request(:put, 'http://mqtt.lelylan.com/devices/1').to_return(status: 202)
+      stub_request(:put, 'http://mqtt.lelylan.com/devices/1').to_return(status: 202, body: fixture('device.json'))
     end
 
     let!(:device) do
@@ -17,7 +17,7 @@ describe Lelylan::Client::Type do
     end
 
     it 'returns the type' do
-      device.should be_nil
+      device.id.should_not be_nil
     end
 
     it 'sends the request' do

data/spec/lelylan/client/subscription_spec.rb

@@ -13,7 +13,7 @@ describe Lelylan::Client::Subscription do
   describe '#subscription' do
 
     before do
-      stub_get('/subscriptions/1').to_return(body: fixture('subscription.json'))
+      stub_request(:get, 'http://id:secret@api.lelylan.com/subscriptions/1').to_return(body: fixture('subscription.json'))
     end
 
     let!(:subscription) do
@@ -25,7 +25,7 @@ describe Lelylan::Client::Subscription do
     end
 
     it 'sends the request' do
-      a_get('/subscriptions/1').with(headers: { Authorization: basic }).should have_been_made
+      a_request(:get, 'http://id:secret@api.lelylan.com/subscriptions/1').should have_been_made
     end
   end
 
@@ -33,7 +33,7 @@ describe Lelylan::Client::Subscription do
   describe '#subscriptions' do
 
     before do
-      stub_get('/subscriptions').to_return(body: fixture('subscriptions.json'))
+      stub_request(:get, 'http://id:secret@api.lelylan.com/subscriptions').to_return(body: fixture('subscriptions.json'))
     end
 
     let!(:subscriptions) do
@@ -45,13 +45,13 @@ describe Lelylan::Client::Subscription do
     end
 
     it 'sends the request' do
-      a_get('/subscriptions').with(headers: { Authorization: basic }).should have_been_made
+      a_request(:get, 'http://id:secret@api.lelylan.com/subscriptions').should have_been_made
     end
 
     context 'with params' do
 
       before do
-        stub_get('/subscriptions').with(query: { per: '25' }).to_return(body: fixture('subscription.json'))
+        stub_request(:get, 'http://id:secret@api.lelylan.com/subscriptions').with(query: { per: '25' }).to_return(body: fixture('subscription.json'))
       end
 
       before do
@@ -59,7 +59,7 @@ describe Lelylan::Client::Subscription do
       end
 
       it 'sends the params' do
-        a_get('/subscriptions').with(headers: { Authorization: basic }).with(query: { per: '25' }).should have_been_made
+        a_request(:get, 'http://id:secret@api.lelylan.com/subscriptions').with(query: { per: '25' }).should have_been_made
       end
     end
   end
@@ -68,11 +68,11 @@ describe Lelylan::Client::Subscription do
   describe '#create_subscription' do
 
     before do
-      stub_post('/subscriptions').with(headers: { Authorization: basic }).with(body: { name: 'Bedroom' }).to_return(body: fixture('subscription.json'))
+      stub_request(:post, 'http://id:secret@api.lelylan.com/subscriptions').with(body: { event: 'property-update' }).to_return(body: fixture('subscription.json'))
     end
 
     let!(:subscription) do
-      lelylan.create_subscription(name: 'Bedroom')
+      lelylan.create_subscription(event: 'property-update')
     end
 
     it 'returns the subscription' do
@@ -80,7 +80,7 @@ describe Lelylan::Client::Subscription do
     end
 
     it 'sends the request' do
-      a_post('/subscriptions').with(headers: { Authorization: basic }).with(body: { name: 'Bedroom' }).should have_been_made
+      a_request(:post, 'http://id:secret@api.lelylan.com/subscriptions').with(body: { event: 'property-update' }).should have_been_made
     end
   end
 
@@ -88,11 +88,11 @@ describe Lelylan::Client::Subscription do
   describe '#update_subscription' do
 
     before do
-      stub_put('/subscriptions/1').with(body: { name: 'Bedroom' }).to_return(body: fixture('subscription.json'))
+      stub_request(:put, 'http://id:secret@api.lelylan.com/subscriptions/1').with(body: { event: 'delete' }).to_return(body: fixture('subscription.json'))
     end
 
     let!(:subscription) do
-      lelylan.update_subscription('1', name: 'Bedroom')
+      lelylan.update_subscription('1', event: 'delete')
     end
 
     it 'returns the subscription' do
@@ -100,7 +100,7 @@ describe Lelylan::Client::Subscription do
     end
 
     it 'sends the request' do
-      a_put('/subscriptions/1').with(headers: { Authorization: basic }).with(body: { name: 'Bedroom' }).should have_been_made
+      a_request(:put, 'http://id:secret@api.lelylan.com/subscriptions/1').with(body: { event: 'delete' }).should have_been_made
     end
   end
 
@@ -108,7 +108,7 @@ describe Lelylan::Client::Subscription do
   describe '#delete_subscription' do
 
     before do
-      stub_delete('/subscriptions/1').to_return(body: fixture('subscription.json'))
+      stub_request(:delete, 'http://id:secret@api.lelylan.com/subscriptions/1').to_return(body: fixture('subscription.json'))
     end
 
     let!(:subscription) do
@@ -120,10 +120,11 @@ describe Lelylan::Client::Subscription do
     end
 
     it 'sends the request' do
-      a_delete('/subscriptions/1').with(headers: { Authorization: basic }).should have_been_made
+      a_request(:delete, 'http://id:secret@api.lelylan.com/subscriptions/1').should have_been_made
     end
   end
 
+
   describe 'when a client param misses' do
 
     let(:client) do
@@ -133,7 +134,7 @@ describe Lelylan::Client::Subscription do
     describe '#subscription' do
 
       before do
-        stub_get('/subscriptions/1').to_return(body: fixture('subscription.json'))
+        stub_request(:get, 'http://id:secret@api.lelylan.com/subscriptions/1').to_return(body: fixture('subscription.json'))
       end
 
       it 'raises a Lelylan::Error' do