ruby_myq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e25cbc16593c4ee50cf10fac89b571b6c79cbd441d17498f19848821bd88549
+  data.tar.gz: 2f2d1f28ed2d5cff5aef474d8596731c5d829b4de942013cfa6f4a57eecd7209
+SHA512:
+  metadata.gz: ae89e6cb88e2b754b752c92782bc061031090e90124ef14c5d7052befd5ba1e6bcf513d94a9a21166f449c368670e44bbade7d5a64f5b36ab0caae772504fde5
+  data.tar.gz: b752f51c0564e8f77f38b5d8e1fcbfcadf9a28a1643f1b0e256bfea78d9d33fc4f95c621886c8983ac9bbdf3af2c06c8fac7a1891e85073c19877044c9c4e39a

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_myq.gemspec
+gemspec
+
+gem 'irb', require: false
+gem 'rubocop', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Pfeffer
+
+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,48 @@
+# RubyMyq
+
+Ruby gem to control a Chaimberlain ruby MyQ system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby_myq'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_myq-X.X.X.gem (Note: X.X.X should be changed to the current version number)
+
+## Usage
+
+To create the gem:
+
+	$ gem build /path/to/ruby_myq/ruby_myq.gemspec
+
+To instantiate the system:
+
+	$ require 'ruby_myq'
+	$ system = RubyMyq::System.new('your_username','your_password')
+
+To see your device list in all it's ruby glory:
+
+	$ system.gateways
+	$ system.garage_doors
+	$ system.garage_doors.count
+
+Have fun with:
+
+	$ system.garage_doors[0].open
+	$ system.garage_doors[0].close
+	$ system.garage_doors[0].status
+
+## 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,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/apiary.apib

@@ -0,0 +1,65 @@
+FORMAT: 1A
+HOST: http://myqexternal.myqdevice.com
+
+# Chamberlain Liftmaster MyQ API
+This is unofficial (and partial) documentation of the Chamberlain/Liftmaster MyQ API used by the iOS and Android apps. It features functionality to monitor and control the garage door system remotely.  A ruby gem implementation of this API is available at http://github.com/pfeffed/liftmaster_myq. 
+
+## Constant Values
+This API has some static values:
+
+Application Id = "Vj8pQggXLhLy0WHahglCD4N1nAkkXQtGYpq2HrHD7H1nvmbT55KqtN6RSF4ILB%2fi"
+
+Culture = 'en' (Note: other regions may be supported as well)
+
+## Login [/Membership/ValidateUserWithCulture?appId={appId}&securityToken=null&username={username}&password={password}&culture={culture}]
+### Send login request [GET]
+You should only need to store the securityToken in the response for subsequent requests.  Also, I have noticed that sometimes the call to login returns a token that does not work.  From time to time, I have found that retrying the login call once or twice gets one that works.
++ Parameters
+    + appId (required, string) ... This appears to be a constant string value associated with the mobile app.
+    + username (required, string) ... The account's email address in url encoded format (i.e. someone@test.com -> someone%40test.com).
+    + password (required, string) ... The account password in url encoded format.
+    + culture (required, string) ... This appears to be the country code.  I have only tried it with 'en'.
+    
++ Response 200 (application/json)
+
+        {"UserId":987654,"SecurityToken":"YOUR_TOKEN_HERE","ReturnCode":"0","ErrorMessage":"","ExecutionTimes":"15.6;46.8;78;62.4","BrandId":2,"BrandName":"Chamberlain"}
+
+## System Detail [/api/UserDeviceDetails?appId={appId}&securityToken={securityToken}]
+### Get devices and information about the MyQ system [GET]
+The security token is the one received from the login request.  If the system comes back without any MyQ units, it may be a sign your login token needs to be refreshed.
++ Parameters
+    + appId (required, string) ... This appears to be a static string associated with the mobile app.
+    + securityToken (required, string) ... This appears to be a static string associated with the mobile app.
+   
++ Response 200 (application/json)
+
+        {"Devices":[{"MyQDeviceId":987654321098,"MyQDeviceTypeId":1,"MyQDeviceTypeName":"Gateway","DeviceId":"876543","DeviceName":"GW000000XXXX","TypeId":49,"TypeName":"Gateway","RegistrationDateTime":"2013-10-12T13:26:38.48","SerialNumber":"GW000000XXXX","UserName":"YOUR-USERNAME","UserConnectServerId":0,"UserCountryId":0,"Attributes":[{"Name":"deviceRecord.response","Value":"{\"id\":987654321,\"deviceCode\":{\"login\":\"XXXXXXXXXXX\",\"password\":\"XX\"},\"type\":{\"id\":47,\"nativeID\":131},\"version\":{\"major\":1,\"minor\":80,\"revision\":1024}}","UpdatedTime":"1382133086081","MyQDeviceTypeAttributeId":0,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"learnmodestate","Value":"0","UpdatedTime":"1384058789400","MyQDeviceTypeAttributeId":3,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"hwver","Value":"1.0","UpdatedTime":"1384990618614","MyQDeviceTypeAttributeId":34,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"desc","Value":"YOUR-GATEWAY-NAME","UpdatedTime":"1382133367601","MyQDeviceTypeAttributeId":28,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"enumeraterequired","Value":"0","UpdatedTime":"1384925170098","MyQDeviceTypeAttributeId":1,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"devtype","Value":"6","UpdatedTime":"1384058783970","MyQDeviceTypeAttributeId":31,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"fwver","Value":"3.0","UpdatedTime":"1384990618527","MyQDeviceTypeAttributeId":33,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"devicetablechecksum","Value":"0","UpdatedTime":"1382133351232","MyQDeviceTypeAttributeId":5,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"enumeratetimestamp","Value":"10/18/2013 4:51:24 PM","UpdatedTime":"1382133085152","MyQDeviceTypeAttributeId":7,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"removeAllDevices.response","Value":"1","UpdatedTime":"1382133084644","MyQDeviceTypeAttributeId":0,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"blver","Value":"1.0","UpdatedTime":"1384990618699","MyQDeviceTypeAttributeId":35,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"devices","Value":"XXXXXXXXX","UpdatedTime":"1382133351238","MyQDeviceTypeAttributeId":25,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"deviceCount.response","Value":"{\"checkSum\":381,\"deviceCount\":1}","UpdatedTime":"1382133085519","MyQDeviceTypeAttributeId":0,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"desiredlearnmode","Value":"0","UpdatedTime":"1384058789403","MyQDeviceTypeAttributeId":2,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"deviceName","Value":"987654321098","UpdatedTime":"","MyQDeviceTypeAttributeId":104,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"customerName","Value":"987654321098","UpdatedTime":"","MyQDeviceTypeAttributeId":4,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"}],"UpdatedBy":"EXT_API","UpdatedDate":"2013-10-18T21:51:24.68"},{"MyQDeviceId":987654,"ParentMyQDeviceId":87654,"MyQDeviceTypeId":2,"MyQDeviceTypeName":"GarageDoorOpener","DeviceId":"XXXXXXXXX","DeviceName":"987654321098","TypeId":47,"TypeName":"Garage Door Opener","UserName":"YOUR-USERNAME","UserConnectServerId":0,"UserCountryId":0,"Attributes":[{"Name":"learnmode","Value":"0","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":55,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"aclossdetect","Value":"0","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":57,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"flasherconnect","Value":"0","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":58,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"worklightstate","Value":"1","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":51,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"gatewayID","Value":"XXXXXX","UpdatedTime":"1382133351237","MyQDeviceTypeAttributeId":49,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"online","Value":"","UpdatedTime":"1384990647995","MyQDeviceTypeAttributeId":0,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"desireddoorstate","Value":"","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":41,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"desc","Value":"Garage Door Opener","UpdatedTime":"1382133355790","MyQDeviceTypeAttributeId":50,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"doorstate","Value":"2","UpdatedTime":"1385067858624","MyQDeviceTypeAttributeId":56,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"controlledlightfeature","Value":"0","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":43,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"diagnosticerrorstate","Value":"0","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":54,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"addedtime","Value":"2013-10-18 21:55:51","UpdatedTime":"1382133351237","MyQDeviceTypeAttributeId":61,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"vacationmode","Value":"0","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":52,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"radiolearnmode","Value":"0","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":53,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"isunattendedopenallowed","Value":"1","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":77,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"isunattendedcloseallowed","Value":"1","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":78,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"requestdevicestatus","Value":"","UpdatedTime":"1385071490018","MyQDeviceTypeAttributeId":59,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"deviceName","Value":"987654321098","UpdatedTime":"","MyQDeviceTypeAttributeId":103,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"},{"Name":"customerName","Value":"987654321098","UpdatedTime":"","MyQDeviceTypeAttributeId":75,"IsDeviceProperty":false,"IsPersistent":false,"IsTimeSeries":false,"IsGlobal":false,"UpdatedDate":"0001-01-01T00:00:00"}],"UpdatedBy":"EXT_API","UpdatedDate":"2013-10-18T21:55:52.167"}],"ReturnCode":"0","ErrorMessage":""}
+
+## Toggle Device State [/Device/setDeviceAttribute]
+### Open or close the door (and turn lights on/off?) [PUT]
+        
+        {
+            "AttributeName":"requestdevicestatus",
+            "DeviceId":"987654321098",
+            "ApplicationId":"APPID-FROM-CONSTANTS",
+            "AttributeValue":"1",
+            "SecurityToken":"YOUR-TOKEN"
+        }
+
++ Response 200 (application/json)
+
+        {"UpdatedTime":"1385071721231","ReturnCode":"0"}
+
+## Check Device State [/Device/getDeviceAttribute?appId={appId}&securityToken={securityToken}&devId={deviceId}&name={command}]
+### Get the status of a particular device attribute [GET]
+This can be used to check to see if a garage door is open, closed, opening, or closing.  There are probably more uses that I have not yet needed.
++ Parameters
+    + appId (required, string) ... This appears to be a static string associated with the mobile app.
+    + securityToken (required, string) ... This appears to be a static string associated with the mobile app.
+    + deviceId (required, string) ... This is the id or deviceId returned in the System Detail call to endpoint /api/UserDeviceDetails referenced above.
+    + command (required, string) ... I have only tried using 'doorstate'
+
++ Response 200 (application/json)
+
+        {"AttributeValue":"2","UpdatedTime":"1385067858624","ReturnCode":"0","ErrorMessage":""}
+

data/lib/ruby_myq.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'ruby_myq/version'
+require 'ruby_myq/system'
+require 'ruby_myq/device'
+
+module RubyMyq
+  APP_ID = 'Vj8pQggXLhLy0WHahglCD4N1nAkkXQtGYpq2HrHD7H1nvmbT55KqtN6RSF4ILB%2Fi'
+  LOCALE = 'en'
+
+  API_VERSION = 'v5'
+  APP_VERSION = 'v5.1'
+
+  HOST_URI = 'api.myqdevice.com/api'
+  LOGIN_ENDPOINT = 'Login'
+  ACCOUNT_ENDPOINT = 'My'
+  DEVICE_LIST_ENDPOINT = 'Devices'
+  DEVICE_SET_ENDPOINT = 'Device/setDeviceAttribute'
+  DEVICE_STATUS_ENDPOINT = '/Device/getDeviceAttribute'
+
+  HEADERS = {
+    'Content-Type' => 'application/json',
+    'MyQApplicationId' => 'JVM/G9Nwih5BwKgNCjLxiFUQxQijAebyyg8QUHr7JOrP+tuPb8iHfRHKwTmDzHOu',
+    'User-Agent' => 'okhttp/3.10.0',
+    'BrandId' => '2',
+    'Culture' => 'en'
+  }.freeze
+end

data/lib/ruby_myq/device.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyMyq
+  module Device
+  end
+end
+
+require 'ruby_myq/device/base'
+require 'ruby_myq/device/garage_door'
+require 'ruby_myq/device/gateway'
+require 'ruby_myq/device/light_switch'

data/lib/ruby_myq/device/base.rb

@@ -0,0 +1,19 @@
+module RubyMyq::Device
+  class Base
+
+    attr_reader :id, :name, :myq_id, :myq_name, :parent_system, :cached_hash
+
+    def initialize(device)
+      @cached_hash = device_hash
+      @parent_system = parent_system
+      @id = device_hash["DeviceId"]
+      device_hash["Attributes"].each do |elem|
+        @name = elem["Value"] if elem["Name"] == "desc"
+      end
+      @myq_id = device_hash["MyQDeviceId"]
+      @myq_name = device_hash["DeviceName"]
+      @device_type = device_hash["MyQDeviceTypeName"]
+    end
+
+  end
+end

data/lib/ruby_myq/device/garage_door.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'ruby_myq/device'
+
+module RubyMyq
+  module Device
+    class GarageDoor
+      def initialize(device, headers)
+        @device = device
+        @headers = headers
+        # API response includes incorrect verion number and http rather than https
+        @device_uri = @device['href'].gsub(/v5/, 'v5.1').gsub(/http/, 'https')
+      end
+
+      def name
+        @device['name']
+      end
+
+      def open
+        change_door_state('open')
+      end
+
+      def close
+        change_door_state('close')
+      end
+
+      def status
+        state = request_door_state
+        state['door_state']
+      end
+
+      def status_since
+        state = request_door_state
+        state['last_update']
+      end
+
+      private
+
+      def request_door_state
+        options = {
+          headers: @headers,
+          format: :json
+          # debug_output: STDOUT
+        }
+        response = HTTParty.get(@device_uri, options)
+        response['state']
+      end
+
+      def change_door_state(command)
+        action_uri = @device_uri + '/Actions'
+
+        options = {
+          headers: @headers,
+          body: { action_type: command }.to_json,
+          format: :json
+          # debug_output: STDOUT
+        }
+        HTTParty.put(action_uri, options)
+      end
+    end
+  end
+end

data/lib/ruby_myq/device/gateway.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'ruby_myq/device'
+
+module RubyMyq
+  module Device
+    class Gateway < Base
+      def status; end
+    end
+  end
+end

data/lib/ruby_myq/device/light_switch.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'ruby_myq/device'
+
+module RubyMyq
+  module Device
+    class LightSwitch < Base
+      def on; end
+
+      def off; end
+
+      def status; end
+    end
+  end
+end

data/lib/ruby_myq/system.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'httparty'
+
+module RubyMyq
+  class System
+    attr_reader :garage_doors
+    def initialize(user, pass)
+      @username = user
+      @password = pass
+      login(@username, @password)
+      request_account
+      discover_endpoints
+    end
+
+    def discover_endpoints
+      empty_device_arrays
+      response = request_device_list
+      devices = response['items']
+      devices.each do |device|
+        instantiate_device(device, @headers)
+      end
+    end
+
+    def find_door_by_id(id)
+      id = id.to_s
+      @garage_doors.each do |door|
+        return door if door.id == id
+      end
+      nil
+    end
+
+    def find_door_by_name(name)
+      @garage_doors.each do |door|
+        return door if door.name == name
+      end
+      nil
+    end
+
+    # private
+
+    def login_uri
+      uri = ''.dup
+      uri << "https://#{RubyMyq::HOST_URI}/"
+      uri << "#{RubyMyq::API_VERSION}/"
+      uri << RubyMyq::LOGIN_ENDPOINT
+    end
+
+    def request_account_uri
+      uri = ''.dup
+      uri << "https://#{RubyMyq::HOST_URI}/"
+      uri << "#{RubyMyq::API_VERSION}/"
+      uri << RubyMyq::ACCOUNT_ENDPOINT
+    end
+
+    def login(username, password)
+      options = {
+        headers: RubyMyq::HEADERS,
+        body: { username: username, password: password }.to_json,
+        format: :json
+        # debug_output: STDOUT
+      }
+
+      response = HTTParty.post(login_uri, options)
+      @security_token = response['SecurityToken']
+      @headers = {}.dup
+      @headers.merge!(RubyMyq::HEADERS)
+      @headers.merge!(SecurityToken: @security_token)
+      # @cached_login_response = response
+      # "logged in successfully"
+    end
+
+    def request_account
+      options = {
+        headers: @headers,
+        body: { expand: 'account' }.to_json,
+        format: :json
+        # debug_output: STDOUT
+      }
+
+      response = HTTParty.get(request_account_uri, options)
+      @account_uri = response['Account']['href'].gsub(/v5/, 'v5.1')
+    end
+
+    def request_device_list
+      uri = "#{@account_uri}/#{RubyMyq::DEVICE_LIST_ENDPOINT}"
+
+      options = {
+        headers: @headers,
+        format: :json
+        # debug_output: STDOUT
+      }
+
+      HTTParty.get(uri, options)
+    end
+
+    def empty_device_arrays
+      @gateways = []
+      @garage_doors = []
+      @lights = []
+    end
+
+    def instantiate_device(device, _headers)
+      if device['device_type'] == 'garagedooropener'
+        @garage_doors << RubyMyq::Device::GarageDoor.new(device, @headers)
+        # elsif device["device_type"] == "hub"
+        #     @gateways << RubyMyq::Device::Gateway.new(device, self)
+        # elsif device["MyQDeviceTypeName"]=="???"
+        # I need a MyQ light switch to implement this feature
+        # @lights << RubyMyq::Device::LightSwitch.new(device)
+      end
+    end
+  end
+end

data/lib/ruby_myq/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyMyq
+  VERSION = '0.0.1'
+end

data/ruby_myq.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_myq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby_myq'
+  spec.version       = RubyMyq::VERSION
+  spec.authors       = ['Jesse Gillies']
+  spec.email         = ['jessegillies@gmail.com']
+  spec.description   = 'Unofficial controller for Chamberlain/Liftmaster MyQ'
+  spec.summary       = 'Gem to access and control the Chamberlain/Liftmaster MyQ garage door system.'
+  spec.homepage      = 'http://github.com/jgillies/ruby_myq'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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_dependency 'httparty', '~> 0.12.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ruby_myq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jesse Gillies
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Unofficial controller for Chamberlain/Liftmaster MyQ
+email:
+- jessegillies@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apiary.apib
+- lib/ruby_myq.rb
+- lib/ruby_myq/device.rb
+- lib/ruby_myq/device/base.rb
+- lib/ruby_myq/device/garage_door.rb
+- lib/ruby_myq/device/gateway.rb
+- lib/ruby_myq/device/light_switch.rb
+- lib/ruby_myq/system.rb
+- lib/ruby_myq/version.rb
+- ruby_myq.gemspec
+homepage: http://github.com/jgillies/ruby_myq
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Gem to access and control the Chamberlain/Liftmaster MyQ garage door system.
+test_files: []