r_aurora 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 343e26bda585adf1932e816d4fea51f467e27ba3
+  data.tar.gz: 7e09ab22c848559017573caa17d0e751e246121a
+SHA512:
+  metadata.gz: d05aa2a9eee06dc9195fc53584aa4cb712daced52e07d43008c6d971d5495ca2aacd927fc36281cf3e9c0a4b65e0747cdaf36195646a1ce1ef5e3982c004ce38
+  data.tar.gz: 47c93895087836441ba7c3971f37951e7027b3b6e0c3130605ab01104d844547555d48604f5cc74e6806bedcc940aee915531579dc93f08f3507ae66c38e2588

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in r_aurora.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 stevestofiel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+# RAurora
+
+This gem provides a simple ruby interface to work with the Aurora OpenAPI.
+
+_(See nanoleaf aurora OpenAPI docs in the developers section of their website `https://forum.nanoleaf.me/docs/openapi`)_
+## Installation
+
+SORRY NOT QUITE READY TO INSTALL YET.  THIS IS STILL A WIP...
+
+~~$ gem install r_aurora~~
+
+## Usage
+
+`require 'r_aurora'`
+
+Assuming you already have retrieved your api token, define the following parameters:
+
+```ruby
+base = 'http://10.0.1.72' #put your aurora IP address here
+api = 'api/v1/'
+token = "51zzxpyupomWxisLiyjcVupDLINqqdHL/" #note the trailing slash...
+```
+Instantiate the class
+```ruby
+aurora = RAurora::Base.new(base, api, token)
+```
+
+Then call the API:
+```ruby
+request_type = "put"
+payload = {"on": {"value": true}} #for on
+payload = {"on": {"value": false}} #for off
+
+aurora.on(request_type, "state/", payload)
+```
+
+1. the first parameter is the request type.  Typically `get` or `put`.
+
+2. the second parameter below represents the node of the JSON structure as defined in the Open API docs. In this case `state/`
+
+3. The third parameter is the json payload, if needed, to pass with the request.
+
+
+I used `method_missing` to synthesize the endpoint. This drastically reduced code duplication but I may change this in the future.  You simply call the endpoint name as a method on the instance and it will auto generate the correct format for the request.  You just need to use underscores in place of the  camelcase names the API uses.  For example if the endpoint in the API is `rhythmConnected` you would try to call `rhythm_connected` on the instance.  See examples below.
+
+---
+
+## Examples of get requests:
+
+```ruby
+request_type = "get"
+
+aurora.rhythm_connected(request_type, "rhythm/")
+```
+returns:
+
+`"200"`
+
+`"true"`
+```ruby
+aurora.hardware_version(request_type, "rhythm/")
+```
+returns:
+
+`"200"`
+
+`"\"1.4\""`
+```ruby
+aurora.ct(request_type, "state/")
+```
+returns:
+
+"200"
+
+{"value"=>4300, "max"=>6500, "min"=>1200}
+
+---
+
+## Examples of put requests:
+
+```ruby
+request_type = "put"
+```
+```ruby
+payload = {"on": {"value": false}}
+aurora.on(request_type, "state/", payload)
+```
+```ruby
+payload = {"brightness": {"value": 100, "duration": 1}}
+aurora.brightness(request_type, "state/", payload)
+```
+```ruby
+payload = {"hue": {"value": 120}}
+aurora.hue(request_type, "state/", payload)
+```
+
+---
+
+You can get ALL information about your aurora panels with the `info` command:
+
+This is the only command that varies from the conventions detailed above.
+
+```ruby
+auroro.info
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stevestofiel/r_aurora.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "r_aurora"
+
+# 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(__FILE__)

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/r_aurora.rb

@@ -0,0 +1,55 @@
+require "r_aurora/version"
+
+module RAurora
+  class Base
+    require 'uri'
+    require 'net/http'
+    require 'json'
+    
+    attr_reader :api, :token
+
+    def initialize(base, api, token)
+      @uri = URI(base)
+      @uri.port = "16021"
+      @api = api
+      @token = token
+    end
+
+    def info
+      req = ::Net::HTTP::Get.new(uri('',''))
+      res = ::Net::HTTP.start(@uri.hostname, @uri.port) {|http|
+        http.request(req)
+      }
+      JSON.parse res.body
+    end
+
+    private
+    def method_missing(method_name, request_type, domain, payload=nil)
+      api_endpoint = camel_case(method_name)
+      case request_type
+      when "get"
+        req = ::Net::HTTP::Get.new(uri(domain, api_endpoint))
+      when "put"
+        req = ::Net::HTTP::Put.new(uri(domain, api_endpoint))
+        req.body = payload.to_json
+      end
+      res = http_request(req)
+      p res.code
+      JSON.parse res.body rescue res.body
+    end
+
+    def http_request(req)
+      ::Net::HTTP.start(@uri.hostname, @uri.port) {|http|
+        http.request(req)
+      }
+    end
+
+    def uri(domain, endpoint)
+      URI.join(@uri, @api, @token, domain, endpoint)
+    end
+
+    def camel_case(method_name)
+      "#{method_name.to_s.split('_').collect(&:capitalize).join.sub(/^\w/) {$&.downcase}}"
+    end
+  end
+end

data/lib/r_aurora/version.rb

@@ -0,0 +1,3 @@
+module RAurora
+  VERSION = "0.1.4"
+end

data/r_aurora.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "r_aurora/version"
+require 'net/http'
+require 'json'
+require 'uri'
+
+Gem::Specification.new do |spec|
+  spec.name          = "r_aurora"
+  spec.version       = RAurora::VERSION
+  spec.authors       = ["Steve Stofiel"]
+  spec.email         = ["stevestofiel@mac.com"]
+
+  spec.summary       = "Ruby Gem for Aurora OpenAPI"
+  spec.description   = "Gem to work with Nanoleaf Aurora OpenAPI"
+  spec.homepage      = "http://ds.stofnet.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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 "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: r_aurora
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Steve Stofiel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Gem to work with Nanoleaf Aurora OpenAPI
+email:
+- stevestofiel@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/r_aurora.rb
+- lib/r_aurora/version.rb
+- r_aurora.gemspec
+homepage: http://ds.stofnet.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.2
+signing_key: 
+specification_version: 4
+summary: Ruby Gem for Aurora OpenAPI
+test_files: []