ketra 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37720a5e1d8c838fe7032637baf15b4a1d2f6dca
-  data.tar.gz: 584b3a99ba32c4bd5cf2c1ab2a3342acb3322c78
+  metadata.gz: 95b00ea816d131398c046ead4a0195e55befd07a
+  data.tar.gz: 43b3ce8604a0a3b0c58c07f415bd516e9fe63328
 SHA512:
-  metadata.gz: 52dd7bc1e83bf51bdc8946c56bddbb0da3e1e99c7f217ec0b769b0d2b8b8b1ca7919623c1d767f66f985cc4d608089f521f4791c67693b54aa86aad28b6f105a
-  data.tar.gz: 708f84945cbc504c80592aa1226b1d6b3d188963aa1a56c5aae5f16902329c89707c0d9e6546d14edf800fb56d32af31b1acefc308456a33b5b9995d51d04187
+  metadata.gz: 5176169e0039713e7ef100a0aadceb3b35d627f66c4a1febd58f7b59f4645e9d7c3ef33ae480975ef685e3f02d49ee53102748c01f314ce1c5396cbf6c1fc55f
+  data.tar.gz: 37871765f712c252c80d9fedb40192db0f94212fa5c5795d1e25cd58ecd9c838170a2550eeebafa9a609baa0999782e25fade900c6496bbebb93dd4553c92830

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+*~
+*.gem
+.byebug_history

data/README.md

@@ -38,13 +38,27 @@ Ketra.authorize(credentials)
 access_token = Ketra.access_token
 ```
 
+#### Set Access Token Directly
+
+```ruby
+Ketra.access_token = 'YOUR ACCESS TOKEN'
+```
+
+### Commands
+
+All commands require authentication.
+
+#### Activate Button
+
+```ruby
+Ketra.hub_serial = 'YOUR HUB SERIAL NUMBER'
+Ketra::Commands.activate_button('YOUR KEYPAD NAME', 'YOUR BUTTON NAME')
+```
 
 ## 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/kennyjpowers/ketra. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/ketra.gemspec

@@ -27,9 +27,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "oauth2", "~> 1.3.1"
+  spec.add_runtime_dependency 'oauth2', '~> 1.3', '>= 1.3.1'
+  spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+  spec.add_dependency 'json', '~> 2.1', '~> 2.1.0'
+  #spec.add_dependency "byebug", "~> 9.0.6"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
 end

data/lib/ketra.rb

@@ -1,13 +1,17 @@
 require 'oauth2'
+require 'rest-client'
+#require 'byebug'
 
 require "ketra/version"
 require "ketra/ketra_client"
+require "ketra/commands"
 
 module Ketra
   class Error < RuntimeError; end
 
   class << self
     attr_writer :callback_url
+    attr_accessor :hub_serial
     #TODO add permission_scopes
   end
 
@@ -32,7 +36,6 @@ module Ketra
   end
 
   PRODUCTION_HOST = 'https://my.goketra.com'
-  API_VERSION = 'v4'
 
   # Set the environment, accepts :production (TODO add :sandbox environment).
   # Defaults to :production
@@ -66,18 +69,6 @@ module Ketra
   def self.authorization_grant
     @authorization_grant || :code
   end
-  
-  # Allow throwing API errors
-  def self.silent_errors=(bool)
-    unless [TrueClass, FalseClass].include?(bool.class)
-      raise(ArguementError, "Silent errors must be set to either true or false")
-    end
-    @silent_errors = bool
-  end
-
-  def self.silenet_errors
-    @silent_errors.nil? ? false : @silent_errors
-  end
 
   def self.callback_url
     @callback_url || 'urn:ietf:wg:oauth:2.0:oob'
@@ -96,10 +87,12 @@ module Ketra
   end
 
   def self.access_token
-    client.access_token.token
+    client.access_token.token if client.access_token
   end
 
-  private
+  def self.access_token=(token)
+    client.access_token = token
+  end
 
   def self.client
     @client ||= KetraClient.new

data/lib/ketra/commands.rb

@@ -0,0 +1,9 @@
+module Ketra
+  module Commands
+    def self.activate_button(keypad_name, button_name, level=65535)
+      endpoint = "activateButton?keypadName=#{keypad_name}&buttonName=#{button_name}"
+      body_params = { "Level": level }
+      Ketra.client.post(endpoint, body_params)
+    end
+  end
+end

data/lib/ketra/ketra_client.rb

@@ -1,8 +1,41 @@
 module Ketra
   class KetraClient
+    LOCAL_ENDPOINT_PREFIX = 'ketra.cgi/api/v1'
+    attr_reader :access_token
 
-    attr_accessor :access_token
+    def access_token=(token)
+      @access_token = OAuth2::AccessToken.new(auth_client, token)
+    end
+
+    # set the hub discovery mode, accepts: :cloud TODO implement :ssdp
+
+    def hub_discovery_mode=(mode)
+      unless [:cloud].include?(mode)
+        raise(ArgumentError, "hub discovery mode must be set to :cloud")
+      end
+      @hub_discovery_mode = mode
+    end
+
+    def hub_discovery_mode
+      @hub_discovery_mode || :cloud
+    end
 
+    # set the api mode, accepts: :local TODO implement :remote
+    # :local mode makes calls directly to the hub
+    def api_mode=(mode)
+      unless [:local].include?(mode)
+        raise(ArgumentError, "api mode must be set to :local")
+      end
+      @api_mode = mode
+    end
+
+    def api_mode
+      @api_mode || :local
+    end
+
+   
+
+    
     # Authorization
 
     def authorization_url
@@ -15,18 +48,65 @@ module Ketra
     def authorize(credentials)
       case Ketra.authorization_grant
       when :code
-        @access_token ||= client.auth_code.get_token(credentials[:authorization_code], :redirect_uri => Ketra.callback_url)
+        @access_token ||= auth_client.auth_code.get_token(credentials[:authorization_code], :redirect_uri => Ketra.callback_url)
       when :password
-        @access_token ||= client.password.get_token(credentials[:username], credentials[:password])
+        @access_token ||= auth_client.password.get_token(credentials[:username], credentials[:password])
+      end
+    end
+
+    def get(endpoint, url_params={})
+      case api_mode
+      when :local
+        RestClient::Request.execute(verify_ssl: false,
+                                    method: :get,
+                                    url: "#{local_url}/#{endpoint}",
+                                    user: '',
+                                    password: @access_token.token,
+                                    content_type: :json,
+                                    headers: {params: url_params})
+      end
+    end
+
+    def post(endpoint, body_params={})
+      case api_mode
+      when :local
+        RestClient::Request.execute(verify_ssl: false,
+                                    method: :post,
+                                    url: "#{local_url}/#{endpoint}",
+                                    user: '',
+                                    password: @access_token.token,
+                                    content_type: :json,
+                                    payload: JSON.generate(body_params))
       end
     end
     
     private
 
-    def client
-      @client ||= OAuth2::Client.new(Ketra.client_id,
-                                     Ketra.client_secret,
-                                     :site => Ketra.host)
+    def hub_ip
+      @hub_ip || discover_hub(Ketra.hub_serial)
+    end
+    
+    def local_url
+      "https://#{hub_ip}/#{LOCAL_ENDPOINT_PREFIX}"
+    end
+   
+
+    def discover_hub(serial_number)
+      case hub_discovery_mode
+      when :cloud
+        response = RestClient.get "#{Ketra.host}/api/n4/v1/query"
+        object = JSON.parse(response)
+        hub_info = object["content"].select{ |h| h["serial_number"] == serial_number }.first
+        unless hub_info.nil?
+          @hub_ip = hub_info["internal_ip"]
+        end
+      end
+    end
+    
+    def auth_client
+      @auth_client ||= OAuth2::Client.new(Ketra.client_id,
+                                          Ketra.client_secret,
+                                          :site => Ketra.host)
     end
     
   end

data/lib/ketra/version.rb

@@ -1,3 +1,3 @@
 module Ketra
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ketra
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenneth Priester
@@ -15,6 +15,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.1
   type: :runtime
@@ -22,8 +25,51 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +102,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 description: A friendly Ruby interface to the Ketra API
 email:
 - kennethjpriester@gmail.com
@@ -85,8 +131,8 @@ files:
 - bin/setup
 - ketra.gemspec
 - lib/ketra.rb
+- lib/ketra/commands.rb
 - lib/ketra/ketra_client.rb
-- lib/ketra/ketra_client.rb~
 - lib/ketra/version.rb
 homepage: http://github.com/kennyjpowers/ketra
 licenses:

data/lib/ketra/ketra_client.rb~

@@ -1,24 +0,0 @@
-module Ketra
-  class KetraClient
-
-    
-    
-
-    # Authorization
-
-    def authorization_url
-      unless authorization_grant == 'implicit'
-        raise(NotImplementedError, "authorization url is only for grant type :implicit")
-      end
-      client.implicit.authorize_url(:redirect_uri => callback_url)
-    end
-    
-
-    private
-
-    def client
-      @client ||= OAuth2::Client.new(client_id, client_secret, :site => host)
-    end
-    
-  end
-end