unifi-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d49f93045b59a6ef961ca4006b3f66b0239d5f2
+  data.tar.gz: b81e2738cbce359dd31b845384a1f4af110e2534
+SHA512:
+  metadata.gz: 90c6783ae4b8c06bc4a6efb77d33d765e7db0dea91979d1768aece7dc9c03104a7f22f4896017cf881866db121c3deec691f3a95b47b3e28c4de8a523ee40ddb
+  data.tar.gz: ee5b4b8f378fc29812df617d565181a1bba609a15294058febbddeebc7d315176b74c842a12c64e028a14456110b61e59b52b8ae68f321fc256a1cf34542c0b5

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# Unifi::Api
+
+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/unifi/api`. 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 'unifi-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unifi-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/unifi-api.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unifi/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/unifi/api.rb

@@ -0,0 +1,218 @@
+require "unifi/api/version"
+
+module Unifi
+  module Api
+    class APIError < Exception
+    end
+
+    class Controller
+      attr_accessor :host, :username, :password, :port, :version, :site_id, :cookies
+
+      def initialize(host, username, password, port=8443, version='v2', site_id='default')
+        @host = host
+        @port = port
+        @version = version
+        @username = username
+        @password = password
+        @site_id = site_id
+        login
+      end
+
+      def url
+        "https://#{host}:#{port}/"
+      end
+
+      def api_url
+        v2_path = 'api/'
+        v3_path = "api/s/#{@site_id}/"
+        api_path = %w(v3 v4).include?(@version) ? v3_path : v2_path
+        "#{url}#{api_path}"
+      end
+
+      def login_url
+        @version == 'v4' ? "#{url}api/login" : "#{url}login"
+      end
+
+      def get_alerts
+        read "#{api_url}list/alarm"
+      end
+
+      def get_alerts_unarchived
+        params ={'json': {'_sort': '-time', 'archived': false}}
+        read "#{api_url}list/alarm", params
+      end
+
+      def get_statistics_last_24h
+        get_statistics_24h(Time.now)
+      end
+
+      def get_statistics_24h(endtime)
+        params = {
+          'attrs': ["wlan_bytes", "wlan-num_sta", "time"],
+          'start': "#{(endtime - 1.day).to_i * 1000}",
+          'end': "#{(endtime - 1.hour).to_i * 1000}"
+        }
+        return read "#{api_url}stat/report/hourly.site", params, :post
+      end
+
+      def get_events
+        read "#{api_url}stat/event"
+      end
+
+      def get_aps
+        params = {'_depth': 2, 'test': 0}
+        read "#{api_url}stat/device", params
+      end
+
+      def get_clients
+        read "#{api_url}stat/sta"
+      end
+
+      def get_users
+        read "#{api_url}list/user"
+      end
+
+      def get_user_groups
+        read "#{api_url}list/usergroup"
+      end
+
+      def get_wlan_conf
+        read "#{api_url}list/wlanconf"
+      end
+
+      def block_client(mac)
+        mac_cmd mac, 'block-sta'
+      end
+
+      def unblock_client(mac)
+        mac_cmd mac, 'unblock-sta'
+      end
+
+      def disconnect_client(mac)
+        mac_cmd mac, 'kick-sta'
+      end
+
+      def restart_ap(mac)
+        mac_cmd mac, 'restart', 'devmgr'
+      end
+
+      def restart_ap_name(name=nil)
+        if name.nil?
+          raise APIError("#{name} is not valid name")
+        end
+        get_aps.each do |ap|
+          if ap['state'] == 1 and ap['name'] == name
+            restart_ap(ap['mac'])
+          end
+        end
+      end
+
+      def archive_all_alerts
+        params = {'cmd': 'archive-all-alarms'}
+        read "#{api_url}cmd/evtmgr", params, :post
+      end
+
+      def create_backup
+        params = {'cmd': 'backup'}
+        result = read "#{api_url}cmd/system", params, :post
+        result[0]['url']
+      end
+
+      def get_backup(target_file='unifi-backup.unf')
+        download_path = create_backup
+
+        unifi_archive = read("#{url}#{download_path}", nil, :post)
+        File.open(target_file, "wb") do |f|
+          f.write(unifi_archive)
+        end
+      end
+
+      def authorize_guest(guest_mac, minutes, up_bandwidth=nil, down_bandwidth=nil, byte_quota=nil, ap_mac=nil)
+        cmd = 'authorize-guest'
+        params = {'mac': guest_mac, 'minutes': minutes}
+
+        if up_bandwidth
+           params['up'] = up_bandwidth
+        end
+        if down_bandwidth
+           params['down'] = down_bandwidth
+        end
+        if byte_quota
+           params['bytes'] = byte_quota
+        end
+        if ap_mac && @version != 'v2'
+           params['ap_mac'] = ap_mac
+        end
+
+        run_command cmd, params
+      end
+
+      def unauthorize_guest(guest_mac)
+        cmd = 'unauthorize-guest'
+        params = {'mac': guest_mac}
+        run_command(cmd, params)
+      end
+
+      def login
+        params = {'username': @username, 'password': @password}
+        params['login'] = 'login' unless version == 'v4'
+
+        options = {
+          verify: false,
+          body: params.to_json,
+          headers: {'Content-Type': 'application/json','Accept': 'application/json'}
+        }
+
+        res = HTTParty.post(login_url, options)
+        @cookies = res.headers['set-cookie']
+        get_data res
+      end
+
+      def logout
+        @cookies = nil
+      end
+
+      private
+
+      def read(url, params=nil, method=:get)
+        options = {
+          verify: false,
+          body: params.to_json,
+          headers: {
+            'Content-Type': 'application/json',
+            'Accept': 'application/json',
+            'Cookie': @cookies || ''
+          }
+        }
+
+        if method == :get
+          get_data HTTParty.get(url, options)
+        elsif method == :post
+          get_data HTTParty.post(url, options)
+        end
+      end
+
+      def get_data(res)
+        obj = res.parsed_response
+        if obj && obj['meta'] && obj['meta']['rc'] != 'ok'
+          raise APIError, obj['meta']['msg']
+        end
+        if obj && obj['data']
+          return obj['data']
+        end
+        obj
+      end
+
+      def run_command(command, params={}, mgr='stamgr')
+          params['cmd'] =  command
+          read "#{api_url}cmd/#{mgr}", params, :post
+      end
+
+      def mac_cmd(target_mac, command, mgr='stamgr')
+          params = {'mac': target_mac}
+          run_command(command, params, mgr)
+      end
+
+    end
+  end
+end

data/lib/unifi/api/version.rb

@@ -0,0 +1,5 @@
+module Unifi
+  module Api
+    VERSION = "0.1.0"
+  end
+end

data/unifi-api.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unifi/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unifi-api"
+  spec.version       = Unifi::Api::VERSION
+  spec.authors       = ["hculap"]
+  spec.email         = ["hculap@gmail.com"]
+
+  spec.summary       = %q{A rewrite of https://github.com/calmh/unifi-api in Ruby.}
+  spec.description   = %q{Ruby Api for UniFi Controller - Ubiquiti Networks Access Points}
+  spec.homepage      = "https://github.com/hculap/unifi-api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'httparty', '~> 0'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: unifi-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hculap
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 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: Ruby Api for UniFi Controller - Ubiquiti Networks Access Points
+email:
+- hculap@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/unifi/api.rb
+- lib/unifi/api/version.rb
+- unifi-api.gemspec
+homepage: https://github.com/hculap/unifi-api
+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.1
+signing_key: 
+specification_version: 4
+summary: A rewrite of https://github.com/calmh/unifi-api in Ruby.
+test_files: []