domoticz 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d599c5d8d26450b7373eb1caf407e4b7b1d29b19
-  data.tar.gz: 23ff38346cdb0ca2694e0ea979eb0d15ae16dae0
+  metadata.gz: ad30fb52aba106a7ece5773561ade61c12712a69
+  data.tar.gz: a2d60e4682cfbb0491d08364a2006a3edeb69623
 SHA512:
-  metadata.gz: ed79decb12a6c75fdfdae4a42ddf24fac049ec352ff6c3fa5badf7dec04e47bab256abd3a2c2a8cd7fe0a38827ebde67e75538e8e71b9a8b25a4a9a0c30e5e52
-  data.tar.gz: a25cdc96bee5df854896a0fc1799bcbb9fb5215738b42e35af4dcc0e42ef983f657c886a9d50544023aab92f2c7c3e1083bb33126d8d6ca50a05ffb49172f9b1
+  metadata.gz: eb56015813ff18e597c48580dd5d4b12aac23b2afcb6e820fabe3d65e399ebbd2df1937d5b6647b616cb5bfc8f36154bbc4140677f6198dca007d7c30c2bcbe5
+  data.tar.gz: a65cd8b0816fa0bdf5661e334848c2ff0a949b1dc56a97e53aaed92e741151b8cd560bf89b4d96a8e00d416f9ec2c6eef592f32dfa33d3e4967f081df486fe57

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/README.md

@@ -1,10 +1,37 @@
-# Domoticz
+# Domoticz [![Circle CI](https://circleci.com/gh/jankeesvw/domoticz.svg?style=svg)](https://circleci.com/gh/jankeesvw/domoticz)
 
 Manage your Domoticz server from Ruby
 
-This gem is work in progress, you cannot yet use this in production.
+This gem is work in progress!
 
-## Contributing
+## Connect to your server
+
+```
+Domoticz.configure do |config|
+  config.server = "http://127.0.0.1/"
+  config.username = "user"
+  config.password = "password"
+end
+```
+
+## Devices
+
+### List all devices
+
+```ruby
+devices = Domoticz::Switch.all
+# => [#<Domoticz::Switch:0x007fc51e203420 @name="Energy", @dimmer=nil, @idx="6", @type="P1 Smart Meter", @subtype="Energy">, #<Domoticz::Switch:0x007fc51e203308 @name="Gas", @dimmer=nil, @idx="7", @type="P1 Smart Meter", @subtype="Gas">, #<Domoticz::Switch:0x007fc51e2031c8 @name="Test switch", @dimmer=nil, @idx="8", @type="Lighting 1", @subtype="X10">]
+```
+
+### Interact with a switch
+```ruby
+switch = Domoticz::Devices.all.first
+switch.on! # turn it on
+switch.off! # turn it off
+switch.toggle! # toggle switch
+```
+
+# Contributing
 
 1. Fork it ( https://github.com/jankeesvw/domoticz/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/domoticz.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
 end

data/lib/domoticz.rb

@@ -1,7 +1,30 @@
 require "domoticz/version"
+require "domoticz/configuration"
+require "domoticz/device"
+require "json"
 
 module Domoticz
-  def self.hello
-    "Hello Domoticz"
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.perform_api_request(params)
+    username = Domoticz.configuration.username
+    password = Domoticz.configuration.password
+
+    uri = URI(Domoticz.configuration.server + "json.htm?" + params)
+    request = Net::HTTP::Get.new(uri)
+    request.basic_auth(username, password) if username && password
+    response = Net::HTTP.start(uri.hostname, uri.port) { |http| http.request(request) }
+
+    JSON.parse(response.body)
   end
 end

data/lib/domoticz/configuration.rb

@@ -0,0 +1,11 @@
+module Domoticz
+  class Configuration
+    attr_accessor :server
+    attr_accessor :username
+    attr_accessor :password
+
+    def initialize
+      self.server = "http://127.0.0.1:8080/"
+    end
+  end
+end

data/lib/domoticz/device.rb

@@ -0,0 +1,58 @@
+module Domoticz
+  class Device
+    attr_accessor :idx
+    attr_accessor :data
+
+    def seconds_since_update
+      Time.now - Time.parse(lastupdate)
+    end
+
+    def on!
+      Domoticz.perform_api_request("type=command&param=switchlight&idx=#{idx}&switchcmd=On")
+    end
+
+    def off!
+      Domoticz.perform_api_request("type=command&param=switchlight&idx=#{idx}&switchcmd=Off")
+    end
+
+    def toggle!
+      Domoticz.perform_api_request("type=command&param=switchlight&idx=#{idx}&switchcmd=Toggle")
+    end
+
+    def temperature
+      temp
+    end
+
+    def dimmer?
+      isDimmer
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      hash = Hash[@data.map { |k, v| [k.downcase, v] }]
+      key = method_sym.to_s.downcase
+
+      if hash.has_key?(key)
+        hash[key]
+      else
+        super
+      end
+    end
+
+    def self.find_by_id(id)
+      all.find { |d| d.idx == id.to_s }
+    end
+
+    def self.all
+      Domoticz.perform_api_request("type=devices&filter=all&used=true")["result"].map do |json|
+        Device.new_from_json(json)
+      end
+    end
+
+    def self.new_from_json(json)
+      device = self.new
+      device.data = json
+      device.idx = json["idx"]
+      device
+    end
+  end
+end

data/lib/domoticz/version.rb

@@ -1,3 +1,3 @@
 module Domoticz
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

data/spec/device_spec.rb

@@ -0,0 +1,107 @@
+require "spec_helper"
+
+describe Domoticz::Device do
+  it "gets all available devices" do
+    stub_server_with_fixture(params: "type=devices&filter=all&used=true", fixture: "switches.json")
+
+    devices = Domoticz::Device.all
+    expect(devices.count).to eq 2
+
+    expect(devices.first.name).to eq "Switch 1"
+    expect(devices.first.dimmer?).to be_truthy
+    expect(devices.first.idx).to eq "1"
+    expect(devices.first.type).to eq "Lighting 1"
+    expect(devices.first.subtype).to eq "X10"
+  end
+
+  it "gets a specific device" do
+    stub_server_with_fixture(params: "type=devices&filter=all&used=true", fixture: "switches.json")
+
+    device = Domoticz::Device.find_by_id(1)
+    expect(device).to be_a Domoticz::Device
+
+    expect(device.name).to eq "Switch 1"
+    expect(device.dimmer?).to be_truthy
+    expect(device.idx).to eq "1"
+    expect(device.type).to eq "Lighting 1"
+    expect(device.subtype).to eq "X10"
+  end
+
+  it "turns on a switch" do
+    stub_server_with_fixture(params: "type=command&param=switchlight&idx=8&switchcmd=On", fixture: "switch_turn_on.json", required: true)
+
+    switch = Domoticz::Device.new
+    switch.idx = "8"
+    switch.on!
+  end
+
+  it "turns off a switch" do
+    stub_server_with_fixture(params: "type=command&param=switchlight&idx=8&switchcmd=Off", fixture: "switch_turn_off.json", required: true)
+
+    switch = Domoticz::Device.new
+    switch.idx = "8"
+    switch.off!
+  end
+
+  it "toggles a switch" do
+    stub_server_with_fixture(params: "type=command&param=switchlight&idx=8&switchcmd=Toggle", fixture: "switch_toggle.json", required: true)
+
+    switch = Domoticz::Device.new
+    switch.idx = "8"
+    switch.toggle!
+  end
+
+  it "tells us how old this data point is" do
+    # "LastUpdate": "2015-12-13 14:02:47",
+    stub_server_with_fixture(params: "type=devices&filter=all&used=true", fixture: "temperature_device.json")
+
+    Timecop.freeze(2015, 12, 13, 14, 2, 51)
+
+    device = Domoticz::Device.find_by_id(47)
+    expect(device.seconds_since_update).to eq 4
+  end
+
+  it "gets the raw json data" do
+    stub_server_with_fixture(params: "type=devices&filter=all&used=true", fixture: "temperature_device.json")
+
+    switches = Domoticz::Device.all
+    expect(switches.first.data).to eq ({
+      "AddjMulti" => 1.0,
+      "AddjMulti2" => 1.0,
+      "AddjValue" => 0.0,
+      "AddjValue2" => 0.0,
+      "BatteryLevel" => 100,
+      "CustomImage" => 0,
+      "Data" => "20.6 C, 45 %",
+      "Description" => "",
+      "DewPoint" => "8.25",
+      "Favorite" => 1,
+      "HardwareID" => 3,
+      "HardwareName" => "razberry",
+      "HardwareType" => "OpenZWave USB",
+      "HardwareTypeVal" => 21,
+      "HaveTimeout" => false,
+      "Humidity" => 45,
+      "HumidityStatus" => "Comfortable",
+      "ID" => "0601",
+      "LastUpdate" => "2015-12-13 14:02:47",
+      "Name" => "Woonkamer",
+      "Notifications" => "false",
+      "PlanID" => "5",
+      "PlanIDs" => [5],
+      "Protected" => false,
+      "ShowNotifications" => true,
+      "SignalLevel" => "-",
+      "SubType" => "WTGR800",
+      "Temp" => 20.6,
+      "Timers" => "false",
+      "Type" => "Temp + Humidity",
+      "TypeImg" => "temperature",
+      "Unit" => 0,
+      "Used" => 1,
+      "XOffset" => "185",
+      "YOffset" => "592",
+      "idx" => "47"
+    })
+  end
+end

data/spec/domoticz_spec.rb

@@ -1,7 +1,51 @@
 require "spec_helper"
 
 describe Domoticz do
-  it "returns hellow world" do
-    expect(Domoticz.hello).to eq "Hello Domoticz"
+  describe "configuration" do
+    it "stores the user name" do
+      Domoticz.configure do |config|
+        config.server = "http://127.0.1.1:8080/"
+        config.username = "username"
+        config.password = "password"
+      end
+      expect(Domoticz.configuration.server).to eq "http://127.0.1.1:8080/"
+      expect(Domoticz.configuration.username).to eq "username"
+      expect(Domoticz.configuration.password).to eq "password"
+    end
+
+  end
+
+  describe ".perform_api_request" do
+    it "performs an api request and parses the resulting JSON" do
+      expect(Net::HTTP).to receive(:start).and_return(double(body: %q{{"result": "ok"}}))
+
+      expect(Domoticz.perform_api_request("param")).to eq({ "result" => "ok" })
+    end
+
+    describe "basic auth" do
+      it "uses basic auth to authenticate" do
+        Domoticz.configure do |config|
+          config.server = "http://127.0.1.1:8080/"
+          config.username = "username"
+          config.password = "password"
+        end
+
+        expect(Net::HTTP).to receive(:start).and_return(double(body: %q{{"result": "ok"}}))
+        expect_any_instance_of(Net::HTTP::Get).to receive(:basic_auth).with("username", "password")
+
+        Domoticz.perform_api_request("param")
+      end
+    end
+
+    it "skips basic auth if no username and password are present" do
+      Domoticz.configure do |config|
+        config.server = "http://127.0.1.1:8080/"
+      end
+
+      expect(Net::HTTP).to receive(:start).and_return(double(body: %q{{"result": "ok"}}))
+      expect_any_instance_of(Net::HTTP::Get).not_to receive(:basic_auth)
+
+      Domoticz.perform_api_request("param")
+    end
   end
-end
+end

data/spec/fixtures/switch_toggle.json

@@ -0,0 +1,4 @@
+{
+  "status": "OK",
+  "title": "SwitchLight"
+}

data/spec/fixtures/switch_turn_off.json

@@ -0,0 +1,4 @@
+{
+  "status": "OK",
+  "title": "SwitchLight"
+}

data/spec/fixtures/switch_turn_on.json

@@ -0,0 +1,4 @@
+{
+  "status": "OK",
+  "title": "SwitchLight"
+}

data/spec/fixtures/switches.json

@@ -0,0 +1,20 @@
+{
+  "result": [
+    {
+      "IsDimmer": true,
+      "Name": "Switch 1",
+      "SubType": "X10",
+      "Type": "Lighting 1",
+      "idx": "1"
+    },
+    {
+      "IsDimmer": false,
+      "Name": "Switch 2",
+      "SubType": "X10",
+      "Type": "Lighting 1",
+      "idx": "2"
+    }
+  ],
+  "status": "OK",
+  "title": "GetLightSwitches"
+}

data/spec/fixtures/temperature_device.json

@@ -0,0 +1,46 @@
+{
+  "result": [
+    {
+      "AddjMulti": 1.0,
+      "AddjMulti2": 1.0,
+      "AddjValue": 0.0,
+      "AddjValue2": 0.0,
+      "BatteryLevel": 100,
+      "CustomImage": 0,
+      "Data": "20.6 C, 45 %",
+      "Description": "",
+      "DewPoint": "8.25",
+      "Favorite": 1,
+      "HardwareID": 3,
+      "HardwareName": "razberry",
+      "HardwareType": "OpenZWave USB",
+      "HardwareTypeVal": 21,
+      "HaveTimeout": false,
+      "Humidity": 45,
+      "HumidityStatus": "Comfortable",
+      "ID": "0601",
+      "LastUpdate": "2015-12-13 14:02:47",
+      "Name": "Woonkamer",
+      "Notifications": "false",
+      "PlanID": "5",
+      "PlanIDs": [
+        5
+      ],
+      "Protected": false,
+      "ShowNotifications": true,
+      "SignalLevel": "-",
+      "SubType": "WTGR800",
+      "Temp": 20.60,
+      "Timers": "false",
+      "Type": "Temp + Humidity",
+      "TypeImg": "temperature",
+      "Unit": 0,
+      "Used": 1,
+      "XOffset": "185",
+      "YOffset": "592",
+      "idx": "47"
+    }
+  ],
+  "status": "OK",
+  "title": "GetLightSwitches"
+}

data/spec/spec_helper.rb

@@ -1 +1,9 @@
-require "domoticz"
+require "domoticz"
+require "support/spec_helpers"
+require "timecop"
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Domoticz.reset
+  end
+end

data/spec/support/spec_helpers.rb

@@ -0,0 +1,8 @@
+def stub_server_with_fixture(params:, fixture:, required: false)
+  json = JSON.parse(File.read("spec/fixtures/" + fixture))
+  if required
+    expect(Domoticz).to receive(:perform_api_request).with(params).and_return(json)
+  else
+    allow(Domoticz).to receive(:perform_api_request).with(params).and_return(json)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domoticz
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Jankees van Woezik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2015-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: 
 email:
 - jankeesvw@gmail.com
@@ -60,15 +74,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - domoticz.gemspec
 - lib/domoticz.rb
+- lib/domoticz/configuration.rb
+- lib/domoticz/device.rb
 - lib/domoticz/version.rb
+- spec/device_spec.rb
 - spec/domoticz_spec.rb
+- spec/fixtures/switch_toggle.json
+- spec/fixtures/switch_turn_off.json
+- spec/fixtures/switch_turn_on.json
+- spec/fixtures/switches.json
+- spec/fixtures/temperature_device.json
 - spec/spec_helper.rb
+- spec/support/spec_helpers.rb
 homepage: https://github.com/jankeesvw/domoticz
 licenses:
 - MIT
@@ -94,5 +118,12 @@ signing_key:
 specification_version: 4
 summary: Manage your Domoticz server from Ruby
 test_files:
+- spec/device_spec.rb
 - spec/domoticz_spec.rb
+- spec/fixtures/switch_toggle.json
+- spec/fixtures/switch_turn_off.json
+- spec/fixtures/switch_turn_on.json
+- spec/fixtures/switches.json
+- spec/fixtures/temperature_device.json
 - spec/spec_helper.rb
+- spec/support/spec_helpers.rb