sensibo-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d4bb676a37a1c8f87ba804b4e9be133db0d992a
+  data.tar.gz: 6758c2639a9448b16651547484f6420911dec82c
+SHA512:
+  metadata.gz: 7bd3b5ec0a5148617ec17c18569015ec7edfd0ecf3b2416df9477484fa4df5858155227b8d2f9248a0f88912fbb05444d53452c91b6f352513958b9df4bf0b48
+  data.tar.gz: 38300218945b1e62c75823616d8b0cde20d87e49e040dcb90f704ad74ab89058d8dd08dc8c128d640b65678e2a2cd1925e06e564713add5cefd44838c6af7e47

data/.gitignore

@@ -0,0 +1,2 @@
+.env
+*.gem

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    nest-api (0.0.1)
+      awesome_print
+      cistern (~> 2.8.2)
+      excon (~> 0.45.5)
+      faraday (~> 0.15.4)
+      faraday_middleware
+      oj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    byebug (11.0.1)
+    cistern (2.8.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    dotenv (2.7.1)
+    excon (0.45.5)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    method_source (0.9.2)
+    multipart-post (2.0.0)
+    oj (3.6.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  dotenv
+  nest-api!
+  pry-byebug
+  rspec
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,23 @@
+# Sensibo API Client
+
+Rewrite of the sensibo API client using Cistern.
+
+## Usage
+
+### Installation
+`gem install sensibo-api`
+
+`require 'sensibo'`
+
+###
+1. Initialize the client
+
+`client = Sensibo.new(api_key: API_KEY)`
+
+2. Get a device
+
+`device = client.devices.first`
+
+3. Set a param
+
+`device.update(fan_level: "strong")`

data/lib/sensibo.rb

@@ -0,0 +1,22 @@
+require "awesome_print"
+require "cistern"
+require "excon"
+require "faraday"
+require "faraday_middleware"
+require "oj"
+
+require "dotenv/load" if File.exists?(".env")
+
+class Sensibo
+  include Cistern::Client.with(interface: :module)
+
+  recognizes :url, :api_key
+
+  require_relative "sensibo/real"
+
+  require_relative "sensibo/models/device"
+  require_relative "sensibo/models/devices"
+
+  require_relative "sensibo/requests/get_devices"
+  require_relative "sensibo/requests/set_device_state"
+end

data/lib/sensibo/models/device.rb

@@ -0,0 +1,55 @@
+class Sensibo::Device
+  include Sensibo::Model
+
+  identity :id
+
+  attribute :battery_voltage,                                       type: :float,   squash: ["measurements", "batteryVoltage"]
+  attribute :config_group,       aliases: :configGroup
+  attribute :fan_level,                                                             squash: ["acState", "fanLevel"]
+  attribute :geofencing,         aliases: :isGeofenceOnExitEnabled, type: :boolean
+  attribute :humidity,                                              type: :float,   squash: ["measurements", "humidity"]
+  attribute :mac_address,        aliases: :macAddress
+  attribute :mode,                                                                  squash: ["acState", "mode"]
+  attribute :model,              aliases: :productModel
+  attribute :native_temperature_unit,                                               squash: ["acState", "nativeTemperatureUnit"]
+  attribute :power_on,                                              type: :boolean, squash: ["acState", "on"]
+  attribute :swing,                                                                 squash: ["acState", "swing"]
+  attribute :target_temperature,                                    type: :float,   squash: ["acState", "targetTemperature"]
+  attribute :temperature,                                           type: :float,   squash: ["measurements", "temperature"]
+  attribute :temperature_unit,                                                      squash: ["acState", "temperatureUnit"]
+
+  def save
+    requires :identity
+
+    temp = if self.temperature_unit == self.native_temperature_unit
+             self.target_temperature
+           elsif self.temperature_unit == "F"
+             c_to_f(f_to_c(self.target_temperature))
+           elsif self.temperature_unit == "C"
+             f_to_c(c_to_f(self.target_temperature))
+           end
+
+    body = {
+      "acState" => {
+        "fanLevel"          => self.fan_level,
+        "mode"              => self.mode,
+        "on"                => self.power_on,
+        "swing"             => self.swing,
+        "targetTemperature" => temp,
+        "temperatureUnit"   => self.temperature_unit,
+      }
+    }
+
+    body = cistern.set_device_state(self.id, body)["result"]
+
+    raise RuntimeError.new("Save Failed") unless body["status"] == "Success"
+  end
+
+  def f_to_c(temp)
+    ((temp - 32) * (5.0/9.0)).round
+  end
+
+  def c_to_f(temp)
+    ((temp * (9.0/5.0)) + 32).round
+  end
+end

data/lib/sensibo/models/devices.rb

@@ -0,0 +1,10 @@
+class Sensibo::Devices
+  include Sensibo::Collection
+
+  model Sensibo::Device
+
+  def all
+    data = cistern.get_devices["result"]
+    load(data)
+  end
+end

data/lib/sensibo/real.rb

@@ -0,0 +1,21 @@
+class Sensibo::Real
+  attr_reader :url, :connection, :api_key
+
+  def initialize(attributes={})
+    @url        = attributes[:url]     || "https://home.sensibo.com"
+    @api_key    = attributes[:api_key] || ENV["API_KEY"]
+    @connection = Faraday.new(url: @url, headers: { "Content-Type" => "application/json" }) do |b|
+      b.adapter :excon
+    end
+  end
+
+  def request(method, path, args={})
+    res = connection.send(method) do |req|
+      req.url "/api/v2#{path}"
+      req.params = { apiKey: self.api_key, fields: "*" }
+      req.body   = Oj.dump(args[:body]) if args[:body]
+    end
+
+    Oj.load(res.body)
+  end
+end

data/lib/sensibo/requests/get_devices.rb

@@ -0,0 +1,7 @@
+class Sensibo::GetDevices
+  include Sensibo::Request
+
+  def real
+    cistern.request(:get, "/users/me/pods")
+  end
+end

data/lib/sensibo/requests/set_device_state.rb

@@ -0,0 +1,7 @@
+class Sensibo::SetDeviceState
+  include Sensibo::Request
+
+  def real(id, body)
+    cistern.request(:post, "/pods/#{id}/acStates", body: body)
+  end
+end

data/lib/sensibo/version.rb

@@ -0,0 +1,3 @@
+class Sensibo
+  VERSION = "0.0.1"
+end

data/sensibo-api.gemspec

@@ -0,0 +1,28 @@
+require_relative "./lib/sensibo/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Eugene Howe"]
+  gem.email         = ["eugene@xtreme-computers.net"]
+  gem.description   = %q{}
+  gem.summary       = %q{}
+  gem.homepage      = "https://github.com/ehowe/sensibo-api.git"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sensibo-api"
+  gem.require_paths = ["lib"]
+  gem.version       = Sensibo::VERSION
+
+  gem.add_dependency "awesome_print",      "~> 1.8"
+  gem.add_dependency "cistern",            "~> 2.8"
+  gem.add_dependency "excon",              "~> 0.45"
+  gem.add_dependency "faraday",            "~> 0.15"
+  gem.add_dependency "faraday_middleware", "~> 0.13"
+  gem.add_dependency "oj",                 "~> 3.6"
+
+  gem.add_development_dependency "byebug",     "~> 11.0"
+  gem.add_development_dependency "dotenv",     "~> 2.7"
+  gem.add_development_dependency "pry-byebug", "~> 3.7"
+  gem.add_development_dependency "rspec",      "~> 3.8"
+end

data/spec/devices_spec.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+describe "Devices" do
+  let(:client) { Sensibo.new }
+
+  it "has a collection of devices" do
+    expect(client.devices.all).to be_a(Sensibo::Devices)
+  end
+
+  context "with a device" do
+    let!(:device)   { client.devices.first }
+
+    it "changes the device fan speed" do
+      original = device.fan_level
+
+      expect { device.update(fan_level: "strong") }.to change { device.fan_level }.from(original).to("strong")
+
+      device.update(fan_level: original)
+    end
+  end
+end

data/spec/test_helper.rb

@@ -0,0 +1 @@
+require_relative "../lib/sensibo"

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: sensibo-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eugene Howe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: cistern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: ''
+email:
+- eugene@xtreme-computers.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/sensibo.rb
+- lib/sensibo/models/device.rb
+- lib/sensibo/models/devices.rb
+- lib/sensibo/real.rb
+- lib/sensibo/requests/get_devices.rb
+- lib/sensibo/requests/set_device_state.rb
+- lib/sensibo/version.rb
+- sensibo-api.gemspec
+- spec/devices_spec.rb
+- spec/test_helper.rb
+homepage: https://github.com/ehowe/sensibo-api.git
+licenses: []
+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.6.14
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/devices_spec.rb
+- spec/test_helper.rb