lelylan-rb 0.0.4 → 0.0.5

data/.gitignore

@@ -1,27 +1,29 @@
-*.gem
-*.rbc
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore temporary files
 *.swp
 *.swo
-*.tmproj
 *.DS_Store
-*~
-.\#*
-.bundle
-.config
-.yardoc
-.yardopts
-.rvmrc
-Gemfile.lock
-InstalledFiles
-\#*
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-tmtags
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+
+# Ignore .rvmrc file.
+/.rvmrc
+
+# Procfile env
+*.env
+
+# Documentation
+docs/
+
+# Local tests
+.test.rb

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.0.5 (May 16, 2013)
+
+* Added [categories](http://dev.lelylan.com/api/types#categories) service
+* Updated physical service to send the secret header
+
 ## v0.0.4 (January 26, 2013)
 
 * Full support to error handling

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    lelylan-rb (0.0.5)
+      addressable (~> 2.2)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.8)
+      hashie (~> 1.2)
+      multi_json (~> 1.3)
+      oauth2 (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    coderay (1.0.8)
+    crack (0.3.2)
+    diff-lcs (1.1.3)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    fuubar (1.1.0)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 1.0.0)
+    growl (1.0.3)
+    guard (1.6.1)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.4.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    hashie (1.2.0)
+    httpauth (0.2.0)
+    json (1.7.6)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
+    listen (0.7.2)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    multi_json (1.5.0)
+    multipart-post (1.1.5)
+    oauth2 (0.8.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    pry (0.9.11.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.0)
+    rake (10.0.3)
+    rb-fsevent (0.9.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.12.1)
+    ruby-progressbar (1.0.2)
+    slop (3.4.3)
+    thor (0.17.0)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fuubar
+  growl
+  guard-rspec
+  json
+  lelylan-rb!
+  rake
+  rb-fsevent
+  rspec
+  webmock

data/README.md

@@ -2,14 +2,13 @@
 
 Ruby client library for [Lelylan API](http://dev.lelylan.com)
 
-## What is Lelylan
+## Introduction
 
-Lelylan makes it easy for developers to monitor and control all devices in
-your house providing a simple, self descriptive and consistent representation of them. Lelylan
-maps every device in your house to a unique URI which will provide a simple access over it.
+#### What is Lelylan
+
+[Lelylan](http://lelylan.com) makes it easy for developers to monitor and control all devices
+in your house providing a simple and consistent REST API.
 
-With Lelylan developers can build secure applications and services that use real-time data
-coming from the real world to create the future connected house.
 
 ## Requirements
 
@@ -28,7 +27,7 @@ gem 'oauth2'
 Development version.
 
 ```ruby
-gem 'lelylan-rb', require: 'lelylan', git: 'https://github.com/lelylan/lelylan-rb', branch: 'master'
+gem 'lelylan-rb', require: 'lelylan', git: 'https://github.com/lelylan/lelylan-rb'
 ```
 
 ## Getting started
@@ -91,54 +90,20 @@ subscriptions = lelylan.subscriptions
 
 ### Implemented 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.
-[See examples](http://dev.lelylan.com/api/devices#ruby).
-
-**Activations** - Easy way to move the device ownership between people.
-[See examples](http://dev.lelylan.com/api/devices#ruby).
-
-**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
-(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.
-[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.
-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).
+Learn how to use Lelylan and AngulasJS in deep.
 
-**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
-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
-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 realtime updates by subscribing to a resource and its related event.
-[See examples](http://dev.lelylan.com/api/realtime#ruby).
-
-**User Profile** - Returns extended information for the authenticated user.
-[See examples](http://dev.lelylan.com/api/core#get-a-user-ruby).
+- [x] [Devices](http://dev.lelylan.com/api/devices#angular).
+- [x] [Activations](http://dev.lelylan.com/api/devices#angular).
+- [x] [Histories](http://dev.lelylan.com/api/devices/histories#angular).
+- [x] [Types](http://dev.lelylan.com/api/types#angular).
+- [x] [Properties](http://dev.lelylan.com/api/types/properties#angular).
+- [x] [Functions](http://dev.lelylan.com/api/types/functions#angular).
+- [x] [Statuses](http://dev.lelylan.com/api/types/statuses#angular).
+- [x] [Locations](http://dev.lelylan.com/api/locations#angular).
+- [x] [Physical devices](http://dev.lelylan.com/api/physicals#angular).
+- [x] [Subscriptions](http://dev.lelylan.com/api/realtime#angular).
+- [x] [User Profile](http://dev.lelylan.com/api/core#get-a-user-angular).
+- [x] [OAuth2](http://dev.lelylan.com/api/oauth#implicit-grant-angular).
 
 
 ### Authorization flows
@@ -175,9 +140,12 @@ Exceptions are raised when a 4xx or 5xx status code is returned.
 
     Lelylan::BadRequest            # 400
     Lelylan::Unauthorized          # 401
+    Lelylan::Forbidden             # 403
     Lelylan::NotFound              # 404
+    Lelylan::NotAcceptable         # 406
     Lelylan::NotValid              # 422
     Lelylan::InternalServerError   # 500
+    Lelylan::NotImplemented        # 501
     Lelylan::BadGateway            # 502
     Lelylan::ServiceUnavailable    # 503
 
@@ -195,7 +163,7 @@ 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).
+Learn more about [errors on Lelylan](http://dev.lelylan.com/api/core#errors).
 
 
 ### Configurations
@@ -216,8 +184,6 @@ lelylan = Lelylan::Client.new(token: token)
 lelylan.endpoint = 'https://lelylan.yourhouse.com'
 ```
 
-Learn more about the [error response structure](http://dev.lelylan.com/api/core#errors).
-
 
 ## Contributing
 

data/lib/lelylan/client.rb

@@ -9,6 +9,7 @@ require 'lelylan/client/type'
 require 'lelylan/client/property'
 require 'lelylan/client/function'
 require 'lelylan/client/status'
+require 'lelylan/client/category'
 require 'lelylan/client/location'
 require 'lelylan/client/subscription'
 require 'lelylan/client/physical'
@@ -37,6 +38,7 @@ module Lelylan
     include Lelylan::Client::Property
     include Lelylan::Client::Function
     include Lelylan::Client::Status
+    include Lelylan::Client::Category
     include Lelylan::Client::Location
     include Lelylan::Client::Subscription
     include Lelylan::Client::Physical

data/lib/lelylan/client/category.rb

@@ -0,0 +1,16 @@
+module Lelylan
+  class Client
+    module Category
+
+      # Public: Returns a list of categories related to owned devices.
+      #
+      # params - The Hash used to refine the search (default: {}).
+      #
+      # Returns Array list of categories.
+      #
+      def categories(params = {})
+        get('/categories', params)
+      end
+    end
+  end
+end

data/lib/lelylan/client/physical.rb

@@ -19,11 +19,7 @@ module Lelylan
       # 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 }
+        headers = { 'X-Physical-Secret' => secret }
 
         request  = Faraday.new do |builder|
           builder.request :json
@@ -34,7 +30,6 @@ module Lelylan
         end
 
         response = request.put(uri, params, headers)
-
         response.body
       end
     end

data/lib/lelylan/version.rb

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

data/spec/fixtures/categories.json

@@ -1,7 +1 @@
-[{
-    "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"
-}]
+[{"name":"lights"},{"name":"locks"},{"name":"thermostats"},{"name":"alarms"},{"name":"meters"},{"name":"cameras"},{"name":"windows"},{"name":"appliances"},{"name":"gardenings"},{"name":"sensors"},{"name":"others"}]

data/spec/lelylan/client/category_spec.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+describe Lelylan::Client::Category do
+
+  let(:lelylan) do
+    a_client
+  end
+
+
+  describe '#categories' do
+
+    before do
+      stub_get('/categories').with(query: { per: 10 }).to_return(body: fixture('categories.json'))
+    end
+
+    let!(:categories) do
+      lelylan.categories(per: 10)
+    end
+
+    it 'returns the categories' do
+      categories.first.name.should_not be_nil
+    end
+
+    it 'sends the request' do
+      a_get('/categories').with(query: { per: 10 }).should have_been_made
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lelylan-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-26 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &2164920560 !ruby/object:Gem::Requirement
+  requirement: &2164363120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2164920560
+  version_requirements: *2164363120
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &2164919960 !ruby/object:Gem::Requirement
+  requirement: &2164362600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *2164919960
+  version_requirements: *2164362600
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2164919140 !ruby/object:Gem::Requirement
+  requirement: &2164361820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *2164919140
+  version_requirements: *2164361820
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &2164918420 !ruby/object:Gem::Requirement
+  requirement: &2164360980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *2164918420
+  version_requirements: *2164360980
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2164917860 !ruby/object:Gem::Requirement
+  requirement: &2164360480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2164917860
+  version_requirements: *2164360480
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2164917360 !ruby/object:Gem::Requirement
+  requirement: &2164359960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2164917360
+  version_requirements: *2164359960
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2164916820 !ruby/object:Gem::Requirement
+  requirement: &2164359440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164916820
+  version_requirements: *2164359440
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2164916180 !ruby/object:Gem::Requirement
+  requirement: &2164358840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164916180
+  version_requirements: *2164358840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164915400 !ruby/object:Gem::Requirement
+  requirement: &2164358160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164915400
+  version_requirements: *2164358160
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2164914940 !ruby/object:Gem::Requirement
+  requirement: &2164357520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164914940
+  version_requirements: *2164357520
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2164914440 !ruby/object:Gem::Requirement
+  requirement: &2164357020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164914440
+  version_requirements: *2164357020
 - !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &2164913860 !ruby/object:Gem::Requirement
+  requirement: &2164356520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164913860
+  version_requirements: *2164356520
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &2164913220 !ruby/object:Gem::Requirement
+  requirement: &2164355840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164913220
+  version_requirements: *2164355840
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &2164912480 !ruby/object:Gem::Requirement
+  requirement: &2164355200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164912480
+  version_requirements: *2164355200
 description: Ruby wrapper for Lelylan API
 email:
 - touch@lelylan.com
@@ -175,6 +175,7 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE.md
 - README.md
@@ -184,6 +185,7 @@ files:
 - lib/lelylan.rb
 - lib/lelylan/authentication.rb
 - lib/lelylan/client.rb
+- lib/lelylan/client/category.rb
 - lib/lelylan/client/device.rb
 - lib/lelylan/client/function.rb
 - lib/lelylan/client/history.rb
@@ -201,7 +203,6 @@ files:
 - lib/lelylan/version.rb
 - spec/faraday/response_spec.rb
 - spec/fixtures/categories.json
-- spec/fixtures/category.json
 - spec/fixtures/consumption.json
 - spec/fixtures/consumptions.json
 - spec/fixtures/device.json
@@ -228,6 +229,7 @@ files:
 - spec/fixtures/type.json
 - spec/fixtures/types.json
 - spec/helper.rb
+- spec/lelylan/client/category_spec.rb
 - spec/lelylan/client/device_spec.rb
 - spec/lelylan/client/function_spec.rb
 - spec/lelylan/client/history_spec.rb
@@ -269,7 +271,6 @@ summary: Ruby wrapper for Lelylan API
 test_files:
 - spec/faraday/response_spec.rb
 - spec/fixtures/categories.json
-- spec/fixtures/category.json
 - spec/fixtures/consumption.json
 - spec/fixtures/consumptions.json
 - spec/fixtures/device.json
@@ -296,6 +297,7 @@ test_files:
 - spec/fixtures/type.json
 - spec/fixtures/types.json
 - spec/helper.rb
+- spec/lelylan/client/category_spec.rb
 - spec/lelylan/client/device_spec.rb
 - spec/lelylan/client/function_spec.rb
 - spec/lelylan/client/history_spec.rb

data/spec/fixtures/category.json

@@ -1,7 +0,0 @@
-{
-    "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"
-}