rtelldus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f940a6aab779967fee354bcc109c600f0d3d7cc
+  data.tar.gz: 1d41eac1fcbfb81361b5b3c6f8b46c838c16f6e5
+SHA512:
+  metadata.gz: 9d5733cf53cf602169193146b9e5190e227ea8a787dee98c1b897b648311108696dbbce215f24b6e138578bd1838ea35b364b0ca69566359740db1908e2ee5ac
+  data.tar.gz: fe0447ce18710619834bfb5b8d86f307e8fe73ca486e146464384c9b32b9879c483d887c64b696631b092c4d7fef6d8d7cc7e61ca375ffc671b791e5781d9bc8

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+lib/config.yaml
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*sublime*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rtelldus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eric Ripa
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Rtelldus
+
+Ruby Framework for accessing the Telldus Live! API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rtelldus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rtelldus
+
+## Usage
+
+Generate your Telldus public and private keys at [api.telldus.com](http://api.telldus.com/keys/index)
+
+Use Rtelldus.authorize to authenticate and get an access_token. The first time you run you will have to follow the onscreen instructions to properly authenticate using OAuth, the public and private keys will be saved together with the access token and access secret in ~/.rtelldus
+
+Authorize will be run automatically on each call if not manually run before, so you can simply just run the calls if you'd like.
+
+### Example usage:
+
+    require "rtelldus"
+
+    # Authorize
+    Rtelldus.authorize
+
+    # List all registered devices:
+    Rtelldus.devices_list
+
+    # Get the ID for the first listed device:
+    Rtelldus.devices_list["device"].first["id"]
+
+    # Turn on device:
+    Rtelldus.device_turn_on "330108"
+
+    # Turn off device:
+    Rtelldus.device_turn_off "330108"
+
+    # Dim a device (value between 0 and 255)L
+    Rtelldus.device_dim "330108", 0
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rtelldus/version.rb

@@ -0,0 +1,3 @@
+module Rtelldus
+  VERSION = "1.0.0"
+end

data/lib/rtelldus.rb

@@ -0,0 +1,113 @@
+require "rtelldus/version"
+require 'oauth'
+require 'json'
+require 'user_config'
+
+module Rtelldus
+  @uconf = UserConfig.new(".rtelldus")
+  def self.authorize
+    # Get API settings
+    unless File.exists? @uconf['api_settings.yaml'].path
+      # No configuration exists, let's request some credentials from the user
+      # Fetch the public and private keys from command line
+      puts "The first time you use the API you need to enter your Public and Private keys, they can be generated at:"
+      puts "\thttp://api.telldus.com/keys/index"
+      puts "\nPublic Key:"
+      public_key = $stdin.gets.strip
+      @uconf["api_settings.yaml"]["consumer_key"] = public_key
+      puts "\nPrivate Key:"
+      private_key = $stdin.gets.strip
+      @uconf["api_settings.yaml"]["consumer_secret"] = private_key
+      ## Persistent settings
+      @uconf["api_settings.yaml"]["api_host"] = "http://api.telldus.com"
+      @uconf["api_settings.yaml"]["request_token_path"] = "/oauth/requestToken"
+      @uconf["api_settings.yaml"]["access_token_path"] = "/oauth/accessToken"
+      @uconf["api_settings.yaml"]["authorize_path"] = "/oauth/authorize"
+      # Save for later use
+      @uconf["api_settings.yaml"].save
+    end
+
+    # Setup OAuth
+    consumer_options = { :site => @uconf["api_settings.yaml"]['api_host'],
+                         :authorize_path => @uconf["api_settings.yaml"]['authorize_path'],
+                         :request_token_path => @uconf["api_settings.yaml"]['request_token_path'],
+                         :access_token_path => @uconf["api_settings.yaml"]['access_token_path'] }
+    consumer = OAuth::Consumer.new(@uconf["api_settings.yaml"]['consumer_key'], @uconf["api_settings.yaml"]['consumer_secret'], consumer_options)
+
+    if File.exists? @uconf["api_token.yaml"].path
+      @access_token = OAuth::AccessToken.new(consumer, @uconf["api_token.yaml"]["access_token"], @uconf["api_token.yaml"]["access_secret"])
+    else
+      # No configuration exists, let's request some access tokens
+      # Fetch a new access token and secret from the command line
+      request_token = consumer.get_request_token
+      puts "Copy and paste the following URL in your browser:"
+      puts "\t#{request_token.authorize_url}"
+      puts "When you sign in and accept, press enter.."
+      verifier = $stdin.gets.strip
+      access_token = request_token.get_access_token(:oauth_verifier => verifier)
+      # Save the token and secret so the script can be used automatically in the future
+      @uconf["api_token.yaml"]["access_token"] = access_token.token
+      @uconf["api_token.yaml"]["access_secret"] = access_token.secret
+      @uconf["api_token.yaml"].save
+      @access_token = OAuth::AccessToken.new(consumer, @uconf["api_token.yaml"]["access_token"], @uconf["api_token.yaml"]["access_secret"])
+    end
+  end
+
+  ## Clients
+  def self.clients_list
+    authorize unless @access_token
+    json_txt = @access_token.get("/json/clients/list", 'x-li-format' => 'json').body
+    clients = JSON.parse(json_txt)
+  end
+
+  ## Devices
+  def self.devices_list
+    authorize unless @access_token
+    json_txt = @access_token.get("/json/devices/list", 'x-li-format' => 'json').body
+    devices = JSON.parse(json_txt)
+  end
+
+  def self.device_info device_id
+    authorize unless @access_token
+    json_txt = @access_token.post("/json/device/info", {"id" => device_id}, 'x-li-format' => 'json').body
+    status = JSON.parse(json_txt)
+  end
+
+  def self.device_turn_on device_id
+    authorize unless @access_token
+    json_txt = @access_token.post("/json/device/turnOn", {"id" => device_id}, 'x-li-format' => 'json').body
+    status = JSON.parse(json_txt)
+  end
+
+  def self.device_turn_off device_id
+    authorize unless @access_token
+    json_txt = @access_token.post("/json/device/turnOff", {"id" => device_id}, 'x-li-format' => 'json').body
+    status = JSON.parse(json_txt)
+  end
+
+  def self.device_dim device_id, level
+    raise "Invalid dimlevel, this value should be 0-255" if level < 0 or level > 255
+    authorize unless @access_token
+    json_txt = @access_token.post("/json/device/dim", {"id" => device_id, "level" => level}, 'x-li-format' => 'json').body
+    status = JSON.parse(json_txt)
+  end
+
+  def self.device_bell device_id
+    authorize unless @access_token
+    json_txt = @access_token.post("/json/device/bell", {"id" => device_id}, 'x-li-format' => 'json').body
+    status = JSON.parse(json_txt)
+  end
+
+  ## Sensors
+  def self.sensors_list
+    authorize unless @access_token
+    json_txt = @access_token.get("/json/sensors/list", 'x-li-format' => 'json').body
+    devices = JSON.parse(json_txt)
+  end
+
+  def self.sensor_info sensor_id
+    authorize unless @access_token
+    json_txt = @access_token.post("/json/sensor/info", {"id" => sensor_id}, 'x-li-format' => 'json').body
+    status = JSON.parse(json_txt)
+  end
+end

data/rtelldus.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rtelldus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rtelldus"
+  spec.version       = Rtelldus::VERSION
+  spec.authors       = ["Eric Ripa"]
+  spec.email         = ["eric@ripa.io"]
+  spec.description   = %q{Ruby Framework for Telldus Live! API}
+  spec.summary       = %q{Ruby Framework for Telldus Live!}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "oauth"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "user_config"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: rtelldus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Ripa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: user_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Framework for Telldus Live! API
+email:
+- eric@ripa.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rtelldus.rb
+- lib/rtelldus/version.rb
+- rtelldus.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby Framework for Telldus Live!
+test_files: []