mystrom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46b2bfe555b9d54a0835384ceed2a450a1941249
+  data.tar.gz: 60ab602a68a9a460b9a75ef9138580dd9eb305e5
+SHA512:
+  metadata.gz: 3f1216fb563b2b40ba063f5ee62d1e17e4a2a6af89c444664a189796837f08770977f83c693544e7b399c79fd8683afc9eb7db73dfbcbcfff679b865ba5e1f57
+  data.tar.gz: ce6c86ed12e773d355a9624ec259deab6ca06e78f4016149c85251e71d29305f8e93f665354cd31d20aff9ab09050b7ac5b6efda14473723756d4c7e1a6a9637

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.0

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Change log
+
+This document represents a high-level overview of changes made to this project.
+It will not list every miniscule change, but will allow you to view - at a
+glance - what to expect from upgrading to a new version.
+
+## [unpublished]
+
+### Added
+
+### Changed
+
+### Fixed
+
+### Security
+
+### Deprecated
+
+### Removed
+
+
+
+## [0.1.0] - 2016-09-13
+
+### Added
+
+- Basic interface to the HTTP API of MyStrom WLAN switches, allowing to read
+  the current throughput, as well as to turn them on and off.
+- Support for tunneling requests via an SSH gateway.
+
+### Changed
+
+### Fixed
+
+### Security
+
+### Deprecated
+
+### Removed
+
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2016 Michael Senn
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,41 @@
+# Mystrom
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mystrom`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mystrom'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mystrom
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mystrom.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mystrom/api_error.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+module MyStrom
+  class APIError < StandardError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+end

data/lib/mystrom/version.rb

@@ -0,0 +1,3 @@
+module Mystrom
+  VERSION = '0.1.0'
+end

data/lib/mystrom/wlan_switch.rb

@@ -0,0 +1,179 @@
+# coding: utf-8
+
+require 'json'
+require 'uri'
+
+require 'httparty'
+
+module MyStrom
+  # Basic binding to the HTTP API exposed by MyStrom WLAN switches.
+  #
+  # @example Basic usage
+  #   require 'mystrom'
+  #
+  #   w = MyStrom::WLANSwitch.new('http://10.60.1.10')
+  #   puts "Current power throughput: #{ w.power }W"
+  #   if w.power > 150
+  #     puts "Using too much power, going dark."
+  #     w.disable
+  #   end
+  #
+  #   if rand() > 0.9
+  #     puts "Messing with family - toggling floor lights."
+  #     w.toggle
+  #   end
+  #
+  # @example Proxying via SSH host
+  #   require 'mystrom'
+  #   require 'net/ssh/gateway'
+  #   gateway = Net::SSH::Gateway.new('jump.example.com', 'johndoe', password: 'hidden')
+  #   w = Mystrom::WLANSwitch.new('http://10.60.1.80', ssh_gateway: gateway)
+  class WLANSwitch
+    # Current power throughput in W
+    # @return [Fixnum]
+    attr_reader :power
+
+    # If data should be refreshed after every operation
+    # @return [Bool]
+    attr_accessor :auto_refresh
+
+    # HTTP URL of the switch
+    # @return [String]
+    attr_accessor :url
+
+    # Initialize a new instance of the class.
+    #
+    # @param url [String] URL of the MySTrom WLAN Switch web interface.
+    # @param opts [Hash] Additional options
+    # @option opts [Bool] :auto_refresh (false) If data should be
+    #   refreshed after every operation.
+    # @option opts [Net::SSH::Gateway] :ssh_gateway (nil) SSH gateway through
+    #   which to proxy the requests.
+    def initialize(url, opts = {})
+      @url = url
+      @auto_refresh = opts.fetch(:auto_refresh, false)
+      @ssh_gateway = opts.fetch(:ssh_gateway, nil)
+      update_data
+    end
+
+    # Enable the relay.
+    #
+    # @raise [APIError] If the information returned by the API was missing or
+    #   incomplete.
+    # @return [Bool] New state of the relay.
+    def enable
+      do_request('relay?state=1')
+      if auto_refresh
+        update
+      else
+        @relay = true
+      end
+
+      @relay
+    end
+
+    # Disable the relay
+    #
+    # @raise [APIError] If the information returned by the API was missing or
+    #   incomplete.
+    # @return [Bool] New state of the relay.
+    def disable
+      do_request('relay?state=0')
+      if auto_refresh
+        update
+      else
+        @relay = false
+      end
+
+      @relay
+    end
+
+    # Toggle the relay.
+    #
+    # @raise [APIError] If the information returned by the API was missing or
+    #   incomplete.
+    # @return [Bool] New state of the relay.
+    def toggle
+      response = do_request('toggle')
+
+      if auto_refresh
+        update
+      else
+        begin
+          data   = JSON.parse(response)
+          @relay = data.fetch('relay')
+        rescue JSON::ParserError => e
+          raise APIError, "Returned JSON was not valid JSON (#{ e.message })"
+        rescue KeyError => e
+          raise APIError, "Returned JSON was missing required key (#{ e.message })"
+        end
+      end
+
+      @relay
+    end
+
+    # Whether relay is enabled.
+    def enabled?
+      @relay
+    end
+
+    # Whether relay is disabled.
+    def disabled?
+      !@relay
+    end
+
+    # Refresh data.
+    #
+    # @raise [APIError] If the information returned by the API was missing or
+    #   incomplete.
+    # @return [WLANSwitch] self
+    def update
+      update_data
+
+      self
+    end
+
+    private
+    def update_data
+      # TODO: Error handling
+      begin
+        data = JSON.parse(do_request('report'))
+        @power = data.fetch('power')
+        @relay = data.fetch('relay')
+      rescue JSON::ParserError => e
+        raise APIError, "Returned JSON was not valid JSON (#{ e.message })"
+      rescue KeyError => e
+        raise APIError, "Returned JSON was missing required key (#{ e.message })"
+      end
+    end
+
+    def do_request(action)
+      if @ssh_gateway
+        response = do_request_ssh(action)
+      else
+        response = do_request_direct(action)
+      end
+
+      case response.code
+      when 200
+        response.body
+      else
+        raise APIError, "HTTP response invalid: Status code: #{ response.code }, Body: #{ response.body }"
+      end
+    end
+
+    def do_request_direct(action)
+      url = "#{ @url }/#{ action }"
+      HTTParty.get(url)
+    end
+
+    def do_request_ssh(action)
+      uri = URI("#{ @url }/#{ action }")
+      @ssh_gateway.open(uri.hostname, uri.port) do |port|
+        uri.hostname = '127.0.0.1'
+        uri.port     = port
+        HTTParty.get(uri.to_s)
+      end
+    end
+  end
+end

data/lib/mystrom.rb

@@ -0,0 +1,7 @@
+require 'mystrom/version'
+
+require 'mystrom/wlan_switch'
+require 'mystrom/api_error'
+
+module MyStrom
+end

data/mystrom.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mystrom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mystrom'
+  spec.version       = Mystrom::VERSION
+  spec.authors       = ['Michael Senn']
+  spec.email         = ['michael@morrolan.ch']
+
+  spec.summary       = %q{Tiny interface to HTTP API of MyStrom WLAN switches}
+  spec.homepage      = "https://bitbucket.org/dragaera/mystrom"
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard'
+
+  spec.add_runtime_dependency 'httparty'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: mystrom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Senn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- michael@morrolan.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mystrom.rb
+- lib/mystrom/api_error.rb
+- lib/mystrom/version.rb
+- lib/mystrom/wlan_switch.rb
+- mystrom.gemspec
+homepage: https://bitbucket.org/dragaera/mystrom
+licenses:
+- Apache-2.0
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Tiny interface to HTTP API of MyStrom WLAN switches
+test_files: []