lightscape 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hashrocket Workstation
+
+MIT License
+
+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,75 @@
+# Lightscape
+
+## Overview
+
+Warning: This is a brand new gem currently, and is likely to undergo
+significant changes in the near future. It also does not include any help with
+finding your bridge's IP address, or getting an API user set up, you'll have to
+figure that out yourself. Support for those features is coming soon.
+
+Lightscape is an API wrapper for the Phillips Hue light bulb bridge. The goal
+of this library is to simplify some of the API and make it easier to manage
+scenes and lighting presets programatically. There is also an existing gem
+(Hue)[https://github.com/soffes/hue] that is a more direct adapter for the same
+API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lightscape'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lightscape
+
+## Usage
+
+Specify which bridge you'd like to use via environment:
+
+    export BRIDGE=192.168.10.100
+
+Specify a user or use the default "rubyclient"
+
+    export HUE_USER="myusername"
+
+Find a light, and change it:
+
+    light = Lightscape::Light.find(1)
+    light.color = :blue
+    light.brightness = 255 # Range of (0..255), 0 is _NOT_ off
+    light.transition_time = 10 # 10 = (10 * 100ms) or 1 second
+    light.update! # Raises the JSON string on failure, or returns true
+
+    light.on! # Turn on immediately
+    light.off! # Turn off immediately
+
+## Colors:
+
+In order to get a basic pass at this going, color support is limited to pre-set
+colors. This will definitely change as the gem develops.
+
+See `Lightscape::COLORS.keys` for a list of colors
+
+## Coming Soon:
+
+* Setup flow (Currently, you must create a user manually)
+* Better methods for setting bridge, user config options
+* More colors, and a way to specify your own
+* CLI
+* Alerting
+* Better access to current attributes
+* Ability to create/load presets that describe light settings, then apply them to lights by name
+* Ability to create/load a "scene" using presets mentioned
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/lightscape.rb

@@ -0,0 +1,32 @@
+require "lightscape/version"
+require "lightscape/light"
+
+module Lightscape
+  module Client
+    extend self
+    attr_writer :bridge, :user
+
+    def base
+      @base ||= RestClient::Resource.new "http://#{bridge}/api/#{user}"
+    end
+
+    def bridge
+      @bridge ||= ENV.fetch("BRIDGE")
+    end
+
+    def user
+      @user ||= ENV.fetch("HUE_USER", "rubyclient")
+    end
+  end
+
+  # Red: 0.675, 0.322
+  # Green: 0.4091, 0.518
+  # Blue: 0.167, 0.04
+
+  COLORS = {
+      red: [0.675, 0.322],
+      green: [0.4077, 0.5154],
+      blue: [0.167, 0.04],
+      white: [0.4440, 0.3500]
+  }.tap { |hsh| hsh.default [0.4440, 0.3500] }
+end

data/lib/lightscape/light.rb

@@ -0,0 +1,60 @@
+require 'rest_client'
+require 'json'
+
+module Lightscape
+  class Light
+    def self.find number
+      new(number)
+    end
+
+    # The API client interface to the light
+    attr_reader :client
+
+    # A hash of pending changes to the light
+    # E.g. { on: true }
+    attr_accessor :pending_changes
+
+    def initialize number
+      @client = Lightscape::Client.base["lights/#{number}"]
+      @pending_changes = {}
+    end
+
+    def on= boolean
+      pending_changes[:on] = boolean
+    end
+
+    def on!
+      self.on = true
+      update!
+    end
+
+    def off!
+      self.on = false
+      update!
+    end
+
+    def color= symbol
+      self.on = true
+      pending_changes[:xy] = COLORS[symbol]
+    end
+
+    def transition_time= duration
+      pending_changes[:transitiontime] = duration
+    end
+
+    def brightness= number
+      self.on = true
+      pending_changes[:bri] = [0, [number, 255].min].max
+    end
+
+    # If you really want to use the same interface as the API
+    alias_method :bri=, :brightness=
+
+    def update!
+      response = client["/state"].put pending_changes.to_json
+      pending_changes = {}
+      raise response.to_str unless response =~ /success/
+      true
+    end
+  end
+end

data/lib/lightscape/version.rb

@@ -0,0 +1,3 @@
+module Lightscape
+  VERSION = "0.0.1"
+end

data/lightscape.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lightscape/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lightscape"
+  spec.version       = Lightscape::VERSION
+  spec.authors       = ["Dave Lyon"]
+  spec.email         = ["dave@davelyon.net"]
+  spec.description   = %q{An API adapter for Phillips Hue lighting system}
+  spec.summary       = %q{An API adapter for Phillips Hue lighting system}
+  spec.homepage      = "https://github.com/davelyon/lightscape"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rest-client", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/light_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Lightscape::Light do
+  describe "getting the current state" do
+  end
+
+  describe "updating the light state" do
+    let(:light) { described_class.find(2) }
+
+    describe "#on!" do
+      it "turns the light on immediately" do
+        expect(light.on!).to be_true
+      end
+    end
+
+    describe "#off!" do
+      it "turns the light off immediately" do
+        expect(light.off!).to be_true
+      end
+    end
+
+    describe "#on=" do
+      it "turns the light on" do
+        light.on = true
+        expect(light.update!).to be_true
+      end
+
+      it "turns the light off" do
+        light.on = false
+        expect(light.update!).to be_true
+      end
+    end
+
+    describe "#color=" do
+      it "turns the light on if the color is changed" do
+        light.off!
+        light.color = :fuscia
+        expect(light.update!).to be_true
+      end
+
+      it "can change the color by name" do
+        light.color = :fuscia
+        expect(light.update!).to be_true
+      end
+    end
+
+    context "changing brightness" do
+
+      it "can change the brightness" do
+        light.brightness = 100
+        expect(light.update!).to be_true
+      end
+
+      context "when the value given is larger than 255" do
+        it "uses 255" do
+          light.brightness = 300
+          expect(light.pending_changes[:bri]).to eq(255)
+        end
+      end
+
+      context "when the value given is negative" do
+        it "uses 0" do
+          light.brightness = -1
+          expect(light.pending_changes[:bri]).to eq(0)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'lightscape'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: lightscape
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dave Lyon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An API adapter for Phillips Hue lighting system
+email:
+- dave@davelyon.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lightscape.rb
+- lib/lightscape/light.rb
+- lib/lightscape/version.rb
+- lightscape.gemspec
+- spec/light_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/davelyon/lightscape
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An API adapter for Phillips Hue lighting system
+test_files:
+- spec/light_spec.rb
+- spec/spec_helper.rb