lelylan-rb 0.0.1

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+*.swp
+*.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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v0.1.0 ()
+
+First version Ruby wrapper for Lelylan API

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+platforms :jruby do
+  gem "jruby-openssl", "~> 0.7"
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', cli: '--format Fuubar --color', all_after_pass: false, :version => 2 do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/LICENSE.md

@@ -0,0 +1 @@
+Copyright (c) 2013 Lelylan

data/README.md

@@ -0,0 +1,218 @@
+# Lelylan Ruby Gem
+
+Ruby client library for [Lelylan API](http://dev.lelylan.com)
+
+
+## Requirements
+
+Ruby client library is tested against MRI 1.9.3.
+
+
+## Installation
+
+Install gem using Bundler.
+
+    gem 'lelylan-rb', require: 'lelylan'
+
+Development version.
+
+    gem 'lelylan-rb', require: 'lelylan', git: 'https://github.com/lelylan/lelylan-rb', branch: 'dev'
+
+
+## Resources
+
+* [Ruby gem documentation](http://rdoc.info/gems/lelylan-rb)
+* [Lelylan API](http://dev.lelylan.com)
+
+
+## Getting started
+
+Require gems.
+
+    require 'rubygems'
+    require 'lelylan-rb'
+
+
+### Create the access token
+
+Create a client (uses the [OAuth2 gem](https://github.com/intridea/oauth2/)).
+
+    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)
+
+Create the access token. The params[:code] contains the authorization
+code created from Lelylan and sent to the redirect_uri.
+
+    token = oauth.auth_code.get_token(params[:code], redirect_uri: redirect_uri)
+
+### Create the Lelylan client.
+
+    client = Lelylan::Client.new(token: token)
+
+### Access Lelylan API
+
+Get 10 devices.
+
+    client.devices(per: 10)
+
+Get a device based on its URI.
+
+    client.device('http://api.lelylan.com/devices/:id')
+
+Search a device based on its name.
+
+    client.devices(name: 'Dimmer').first
+
+Create a device (in this case we suppose the type is a dimmer)
+
+    device = client.create_device(name: 'Closet dimmer', type_uri: dimmer.uri)
+
+Execute a function.
+
+    client.execute(device.uri, function.uri)
+
+Get a public type based on its URI. Remember, when a resource is public the client
+with a token is not needed.
+
+    Lelylan.type('http://api.lelylan.com/types/:id')
+
+
+## More examples
+
+For more examples check out the [ruby gem documentation](http://rdoc.info/gems/lelylan-rb).
+
+* [Device examples](docs/Lelylan/Client/Devices)
+* [Consumption examples](docs/Lelylan/Client/Consumptions)
+* [Hisotry examples](docs/Lelylan/Client/Histories)
+* [Types examples](docs/Lelylan/Client/Types)
+* [Properties examples](docs/Lelylan/Client/Properties)
+* [Functions examples](docs/Lelylan/Client/Functions)
+* [Statuses examples](docs/Lelylan/Client/Statuses)
+* [Categories examples](docs/Lelylan/Client/Categories)
+* [Locations examples](docs/Lelylan/Client/Locations)
+
+## Authorization flows
+
+Lelylan support four OAuth2 authorization flows.
+
+### Authorization code flows
+
+    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
+
+    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
+
+    oauth = OAuth2::Client.new(client_id, client_secret, site: site)
+    token = oauth.password.get_token('email', 'password')
+
+### Client credentials flow
+
+    token = oauth.client_credentials.get_token
+
+All access tokens, when expired, are automatically refreshed.
+
+
+## Settings
+
+### API endpoint
+
+Configuration block.
+
+    Lelylan.configure { |c| c.endpoint = 'https://lelylan.yourhouse.com' }
+    @client = Lelylan::Client.new(token: token)
+
+Client instance.
+
+    @client = Lelylan::Client.new(token: token)
+    @client.endpoint = 'https://lelylan.yourhouse.com'
+
+
+## Errors
+
+Exceptions are raised when a 4xx or 5xx status code is returned.
+
+    Lelylan::BadRequest            # 400
+    Lelylan::Unauthorized          # 401
+    Lelylan::NotFound              # 404
+    Lelylan::NotValid              # 422
+    Lelylan::InternalServerError   # 500
+    Lelylan::BadGateway            # 502
+    Lelylan::ServiceUnavailable    # 503
+
+
+Through the error message attribute you can access the error information.
+
+    begin
+      @type = Lelylan::Type.type("https://type.lelylan.com/types/not_existing_uri")
+    rescue Lelylan::NotFound => e
+      puts "The resource #{e.message.error.uri} was not found"
+    end
+
+Learn more about the [error response structure](http://dev.lelylan.com/rest/core/#errors).
+
+
+## Contributing
+
+Fork the repo on github and send a pull requests with topic branches. Do not forget to 
+provide specs to your contribution.
+
+
+### Running specs
+
+* Fork and clone the repository.
+* Run `gem install bundler` to get the latest for the gemset.
+* Run `bundle install` for dependencies.
+* Run `bundle exec guard` and press enter to execute all specs.
+
+
+## Spec guidelines
+
+Follow [rspec best practices](https://docs.google.com/document/d/1gi00-wwPaLk5VvoAJhBVNh9Htw4Rwmj-Ut88T4M2MwI/edit?hl=en#) guidelines.
+
+
+## Coding guidelines
+
+Follow [github](https://github.com/styleguide/) guidelines.
+
+
+## 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 
+
+* [GIT Repository](http://github.com/lelylan/lelylan-rb)
+* [Lelylan Dev Center](http://dev.lelylan.com)
+* [Lelylan Site](http://lelylan.com)
+
+
+## Authors
+
+[Andrea Reginato](http://twitter.com/andreareginato)
+
+
+## Contributors
+
+Special thanks to the following people for submitting patches.
+
+
+## Changelog
+
+See [CHANGELOG](people/blob/master/CHANGELOG.md)
+
+
+## Copyright
+
+Copyright (c) 2013 [Lelylan](http://lelylan.com). See [LICENSE](people/blob/master/LICENSE.md) for details.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['README.md', 'CHANGELOG.md', 'lib/lelylan/client/**/*.rb']
+    task.options = [
+      '--plugin', 'yard-tomdoc',
+      '--markup-provider', 'redcarpet',
+      '--markup', 'markdown',
+      '--output-dir', 'doc'
+    ]
+  end
+end

data/lelylan_rb.gemspec

@@ -0,0 +1,36 @@
+# encoding: utf-8
+require File.expand_path('../lib/lelylan/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  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.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/faraday/response/raise_http_error.rb

@@ -0,0 +1,35 @@
+require 'faraday'
+require 'multi_json'
+
+module Faraday
+  class Response::RaiseHttpError < Response::Middleware
+    def on_complete(response)
+      case response[:status].to_i
+      when 400
+        raise Lelylan::BadRequest, error_message(response)
+      when 401
+        raise Lelylan::Unauthorized, error_message(response)
+      when 403
+        raise Lelylan::Forbidden, error_message(response)
+      when 404
+        raise Lelylan::NotFound, error_message(response)
+      when 406
+        raise Lelylan::NotAcceptable, error_message(response)
+      when 422
+        raise Lelylan::UnprocessableEntity, error_message(response)
+      when 500
+        raise Lelylan::InternalServerError, error_message(response)
+      when 501
+        raise Lelylan::NotImplemented, error_message(response)
+      when 502
+        raise Lelylan::BadGateway, error_message(response)
+      when 503
+        raise Lelylan::ServiceUnavailable, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      response[:body]
+    end
+  end
+end

data/lib/lelylan.rb

@@ -0,0 +1,26 @@
+require 'lelylan/configuration'
+require 'lelylan/client'
+require 'lelylan/error'
+require 'oauth2'
+
+module Lelylan
+  extend Configuration
+
+  class << self
+
+    # Alias for Lelylan::Client.new
+    def new(options={})
+      Lelylan::Client.new(options)
+    end
+
+    # Delegate to Lelylan::Client.new
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/lelylan/authentication.rb

@@ -0,0 +1,11 @@
+module Lelylan
+  module Authentication
+    def authentication
+      token ? { token: token } : {}
+    end
+
+    def authenticated?
+      !authentication.empty?
+    end
+  end
+end

data/lib/lelylan/client.rb

@@ -0,0 +1,47 @@
+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'
+
+module Lelylan
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options={})
+      options = Lelylan.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      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
+  end
+end