hass-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 424e5b5945d9b3664fcd367db46bf2afe2f8473e4fa225cd0ee6824e7c2f0e76
+  data.tar.gz: 8b3191a2e3aaf64f253c0f957a01003a8258ac83bcae04320d31d58887d51d6c
+SHA512:
+  metadata.gz: 8d8480e5f51bdc57622714871afca209e35943305e32015f7411b1d6305191ac3e1579065f534fda3c484142bc577d71ef6d5b6b4b505f86f778808514d74808
+  data.tar.gz: 8ea81f919350830449e0d4b6b4e71188cef3dde701f3a17730df3c777abcb2410123db9100917298b22faef273b8c8f8a928666c39d3a60dc399bf244c3dc09f

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# hass, Ruby client for HomeAssistant
+
+hass is a simple Ruby client for the HomeAssistant API.
+
+## Installation
+
+Install the gem via 
+
+```bash
+gem install hass
+```
+
+or put it in your Gemfile
+
+```ruby
+gem 'hass'
+```
+
+## Usage
+
+### Command line client
+
+The command line client allows to send simple commands to your HomeAssistant instance.
+
+You need to set the environment variables HASS_HOST, HASS_PORT, and HASS_TOKEN. To get your API token, log in to your HomeAssistant instance and go your profile (the initials in the sidebar). Then scroll down and ceate an authentication token.
+
+To set these variables in the shell use:
+```
+export HASS_HOST=your-hostname.example.com
+export HASS_PORT=8123
+export HASS_TOKEN=abcdef
+export HASS_TLS=1
+```
+
+HASS_SSL=1 ensures a TLS (SSL) connection to your server.
+
+```bash
+hass-send <entity_id> <service>
+```
+
+for example:
+
+```bash
+hass-send light.living_room turn_on
+hass-send light.living_room turn_off
+hass-send light.living_room toggle
+```
+
+Always use the full object name (with the dot) so the client can derive the object type.
+
+### Library
+
+A simple script the toogle a light switch might look like this:
+
+```ruby
+require 'hass/client'
+
+client = Hass::Client.new('localhost', 8123, 'api_token')
+
+light = client.light('light.living_room')
+light.toggle
+```

data/bin/hass-send

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'hass/client'
+
+HOST = ENV['HASS_HOST'] ? ENV['HASS_HOST'].freeze : 'localhost'.freeze
+PORT = ENV['HASS_PORT'] ? ENV['HASS_PORT'].to_i : 8123
+TOKEN = ENV['HASS_TOKEN']
+
+entity_id = ARGV[0]
+domain = entity_id.split('.').first
+service = ARGV[1]
+
+hass = Hass::Client.new(HOST, PORT, TOKEN)
+hass.send(domain.to_sym, entity_id).send(service.to_sym)

data/hass-ruby.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hass-client'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Gerrit Visscher']
+  spec.email         = ['gerrit@visscher.de']
+  spec.summary       = 'A small library to access Home Assistant.'
+  spec.description   = 'Read and write to the HomeAssistant API. Control your smart home devices via Ruby/CLI.'
+  spec.homepage      = 'https://github.com/kayssun/hass-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+end

data/lib/hass/client.rb

@@ -0,0 +1,98 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'hass/domain'
+
+module Hass
+  # The HomeAssistant server
+  class Client
+    def initialize(host, port, token, base_path = '/api')
+      @host = host
+      @port = port
+      @token = token
+      @base_path = base_path
+      prepare_domains
+      prepare_methods
+    end
+
+    def get(path)
+      path = @base_path + path
+      request = Net::HTTP::Get.new path
+      header.each_pair { |field, content| request[field] = content }
+      response = send_http(request)
+      parse(response.body)
+    end
+
+    def post(path, data)
+      path = @base_path + path
+      request = Net::HTTP::Post.new path
+      request.body = data.to_json
+      header.each_pair { |field, content| request[field] = content }
+      response = send_http(request)
+      parse(response.body)
+    end
+
+    def send_http(request)
+      Net::HTTP.start(@host, @port, use_ssl: true) do |http|
+        response = http.request request
+        if response.code.to_i > 299
+          handle_http_error(response)
+          return {} # if handle does not throw an exception
+        end
+        return response
+      end
+    end
+
+    def handle_http_error(response)
+      raise "Server returned #{response.code}: #{response.body}"
+    end
+
+    def parse(response_text)
+      JSON.parse(response_text)
+    rescue JSON::ParserError => e
+      puts "Cannot parse JSON data: #{e}"
+      puts response_text
+    end
+
+    def header
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{@token}",
+        'Accept-Encoding' => 'identity'
+      }
+    end
+
+    def domains
+      @domains ||= get('/services')
+    end
+
+    def snake_to_camel(text)
+      text.split('_').collect(&:capitalize).join
+    end
+
+    def prepare_domains
+      domains.each do |domain|
+        domain_name = snake_to_camel(domain['domain'])
+        domain_class = Class.new(Domain)
+        domain_class.const_set('DATA', domain)
+        domain['services'].keys.each do |service|
+          domain_class.send(:define_method, service.to_sym) do |params = {}|
+            execute_service(service, params)
+          end
+        end
+        Hass.const_set(domain_name, domain_class)
+      end
+    end
+
+    def prepare_methods
+      domains.each do |domain|
+        domain_name = snake_to_camel(domain['domain'])
+        self.class.send(:define_method, domain['domain'].to_sym) do |entity_id|
+          domain_class = Hass.const_get(domain_name).new(entity_id)
+          domain_class.client = self
+          domain_class
+        end
+      end
+    end
+  end
+end

data/lib/hass/domain.rb

@@ -0,0 +1,47 @@
+module Hass
+  # Base class for all domains (lights, switches, media_player...)
+  class Domain
+    attr_accessor :client
+    attr_reader :entity_id
+
+    # Just to make sure, the constant exists
+    DATA = {}.freeze
+
+    def initialize(entity_id)
+      @entity_id = entity_id
+    end
+
+    def required_fields(method_name)
+      data['services'][method_name]['fields'].keys.reject { |name| name == 'entity_id' }
+    end
+
+    def check_params(method_name, given_params)
+      required_fields(method_name).each do |required_field|
+        next if given_params.key?(required_field)
+
+        raise "Parameter #{required_field} might be missing. #{method_help(method_name)}"
+      end
+    end
+
+    # Returns a method description as a help text
+    def method_help(method_name)
+      param_help = required_fields(method_name).map { |name| "#{name}: #{name}_value" }
+      method_hint = "#{method_name}(#{param_help.join(', ')})"
+      fields = data['services'][method_name]['fields']
+      method_description = fields.keys.map { |field| "#{field}: #{fields[field]['description']}" }.join("\n")
+      "Hint: you can call this method with #{method_hint}\n#{method_description}"
+    end
+
+    def execute_service(service, params = {})
+      params['entity_id'] = @entity_id
+      @client.post("/services/#{data['domain']}/#{service}", params)
+    rescue RuntimeError => error
+      puts "Rescuing from #{error.class}: #{error}"
+      check_params(service, params)
+    end
+
+    def data
+      self.class.const_get('DATA')
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: hass-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerrit Visscher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Read and write to the HomeAssistant API. Control your smart home devices
+  via Ruby/CLI.
+email:
+- gerrit@visscher.de
+executables:
+- hass-send
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/hass-send
+- hass-ruby.gemspec
+- lib/hass/client.rb
+- lib/hass/domain.rb
+homepage: https://github.com/kayssun/hass-ruby
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A small library to access Home Assistant.
+test_files: []