arlo 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44cee407e50a4c30b276fb1cecb57a98cdd75901
-  data.tar.gz: d38d7b7ae6aeac5a63046b9cdcc11befe46912d7
+  metadata.gz: 2ef361a03fce87641da660189ebb83dd3b7fbfc4
+  data.tar.gz: d89c72f4e22601bf702807624fb515116b8c5f68
 SHA512:
-  metadata.gz: c0f8c8fdf8139f0f3158431f36d3eac1cd178b77e8504be5d3fcb25d71c689639a87b7dae69574c4691a9f375d5cc0107078c677ebd3a58de97ad5a37d017378
-  data.tar.gz: 02d385f3f1e1ec5ee9f97aff371353b2d9c627b2f34a7755d3bf83652fcc0772e75232f67bfbbabd93f121d798465f2032f07a1fc7285a9e2001223cc123f9f1
+  metadata.gz: 5aa0bccc7721415c7a78e6b745b45a81acf4ed67828dbe12de1099ca3362fd47e839e2d97c4f25b0f7140f6ff634495052fa394855321359c878a86d9b289657
+  data.tar.gz: 96c787a6bd3f6716e8f43c1a64fc44adc5cb80d11ffe308e006a34c9e65123b1f891b7da39b8c19f43a89c549f2fc3c08712db39f9b063801b98abae5ad6d07b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    arlo (0.0.3)
+    arlo (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/arlo.svg)](https://badge.fury.io/rb/arlo) [![Build Status](https://travis-ci.org/ihassin/arlo.svg?branch=master)](https://travis-ci.org/ihassin/arlo)
 
-Get information about your Arlo account as well as your devices.
+Get and set information about your Arlo account as well as your devices.
 
 # Installation
 
@@ -35,37 +35,77 @@ Set up the environment variables reflecting your Arlo credentials:
     export ARLO_EMAIL=xxx
     export ARLO_PASSWORD=yyy
 
-## get_token
-
-Call this to gain access to the other APIs.
-
 ## get_profile
 
 Call this to get your profile information.
 
+```
+api = Arlo::API.new
+profile = api.get_profile
+firstName = api.profile['data']['firstName']
+```
+
+Note: This method is implicitly called when instantiating the API object, so you can directly see the profile by:
+```
+api = Arlo::API.new
+firstName = api.profile['data']['firstName']
+```
+
 ## get_devices
 
 Call this to get the list of devices (including basestations) registered with the account.
 
+```
+api = Arlo::API.new
+devices = api.get_devices
+first_device = api.devices['data'][0]
+```
+
+Note: This method is implicitly called when instantiating the API object, so you can directly see the devices by:
+```
+api = Arlo::API.new
+first_device = api.devices['data'][0]
+```
+
 ## get_device_info
 
 Call this to get device information.
 
+```
+api = Arlo::API.new
+camera1 = api.get_device_info 'Camera1"
+```
+
+## arm_device
+
+Call this to arm or disarm a device
+
+```
+api = Arlo::API.new
+camera1 = api.arm_device 'Camera1", true|false
+```
+
 ## get_library
 
 Call this to get the library's index of all the recordings it has between the two supplied dates.
 
+```
+api = Arlo::API.new
+library = api.get_library '20180802', '20180803'
+```
+
 # TODO
 
-* Provide a convenient interface to manage devices
-* Control cameras (start/stop recordings)
+* Control cameras (start/stop recordings, take snapshots)
 * Download videos
 
 # 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).
+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
 

data/changelog.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 2018-08-05
+
+### Breaking
+
+* No need to pass the token to methods anymore
+* No need to pass the device-list to methods
+
+### Non-breaking
+
+* API object is logged-in when created
+* Devices and Profile are loaded when API object is created
+* Added arm/disarm API method

data/lib/arlo.rb

@@ -2,7 +2,7 @@ require_relative 'arlo/network_helper'
 
 module Arlo
   require 'arlo/version'
-  require 'arlo/token'
+  require 'arlo/init'
   require 'arlo/profile'
   require 'arlo/devices'
   require 'arlo/library'

data/lib/arlo/devices.rb

@@ -1,13 +1,35 @@
+require 'securerandom'
+
 module Arlo
   class API
-    def get_devices token
-      profile = get('https://arlo.netgear.com/hmsweb/users/devices', token)
-      JSON.parse(profile.body)
+    def get_devices
+      devices = get 'https://arlo.netgear.com/hmsweb/users/devices'
+      @devices = JSON.parse(devices.body)
     end
 
-    def get_device_info device_name, device_list
+    def get_device_info(device_name)
       raise 'Missing device_name' unless device_name
-      device_list['data'].select {|device| device['deviceName'] == device_name }[0]
+      @devices['data'].select {|device| device['deviceName'] == device_name }[0]
+    end
+
+    def arm_device(base_station, armed)
+      station_id = base_station['deviceId']
+      payload = {
+        'from': 'arlogem',
+        'to': station_id,
+        'action': 'set',
+        'resource': 'modes',
+        'transId': SecureRandom.uuid,
+        'publishResponse': true,
+        'properties': {
+          'active': armed ? 'mode1' : 'mode0'
+        }
+      }
+
+      ret_val = post("https://arlo.netgear.com/hmsweb/users/devices/notify/#{station_id}",
+                     payload,
+                     'xcloudId': base_station['xCloudId'])
+      JSON.parse(ret_val.body)
     end
   end
 end

data/lib/arlo/{token.rb → init.rb}

@@ -2,22 +2,35 @@ module Arlo
   class API
 
     def initialize
-      @@token = nil
+      @token = login
+      @devices = get_devices
+      @profile = get_profile
     end
 
-    def get_token
-      return @@token if @@token
+    def token
+      @token
+    end
+
+    def devices
+      @devices
+    end
+
+    def profile
+      @profile
+    end
+
+    def login
       email = ENV['ARLO_EMAIL']
       raise 'Missing ARLO_EMAIL environment variable' unless email
       password = ENV['ARLO_PASSWORD']
       raise 'Missing ARLO_PASSWORD environment variable' unless password
 
       payload = {
-        "email": email,
-        "password": password
+        'email': email,
+        'password': password
       }
       response = post('https://arlo.netgear.com/hmsweb/login/v2', payload)
-      @@token = JSON.parse(response.body)['data']['token']
+      JSON.parse(response.body)['data']['token']
     end
 
   end

data/lib/arlo/library.rb

@@ -1,11 +1,11 @@
 module Arlo
   class API
-    def get_library(token, from_date, to_date)
+    def get_library(from_date, to_date)
       payload = {
-        "dateFrom": "20180802",
-        "dateTo": "20180803"
+        'dateFrom': from_date,
+        'dateTo': to_date
       }
-      library = post('https://arlo.netgear.com/hmsweb/users/library', payload, token)
+      library = post('https://arlo.netgear.com/hmsweb/users/library', payload)
       JSON.parse(library.body)
     end
   end

data/lib/arlo/network_helper.rb

@@ -5,26 +5,35 @@ require 'openssl'
 
 module Arlo
   class API
-    def get url, token
+    def get url
       uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
 
       request = Net::HTTP::Get.new(uri)
       request.add_field('Content-Type', 'application/json;charset=UTF-8')
-      request.add_field('Authorization', token)
+      request.add_field('Authorization', @token)
 
       http.request(request)
     end
 
-    def post url, payload, token = nil
+    def post url, payload, xheaders = nil
       uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
 
       request = Net::HTTP::Post.new(uri)
-      request.add_field('Content-Type', 'application/json;charset=UTF-8')
-      request.add_field('Authorization', token) if token
+
+      headers = {
+        'Content-Type': 'application/json;charset=UTF-8',
+        'Authorization': @token
+      }
+
+      headers.merge!(xheaders) if xheaders
+
+      headers.each do |key, value|
+        request.add_field(key, value)
+      end
       request.body = payload.to_json
 
       http.request(request)

data/lib/arlo/profile.rb

@@ -1,8 +1,8 @@
 module Arlo
   class API
-    def get_profile token
-      profile = get('https://arlo.netgear.com/hmsweb/users/profile', token)
-      JSON.parse(profile.body)
+    def get_profile
+      profile = get 'https://arlo.netgear.com/hmsweb/users/profile'
+      @profile = JSON.parse(profile.body)
     end
   end
 end

data/lib/arlo/version.rb

@@ -1,3 +1,3 @@
 module Arlo
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arlo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Itamar Hassin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-04 00:00:00.000000000 Z
+date: 2018-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,13 +106,14 @@ files:
 - arlo.gemspec
 - bin/console
 - bin/setup
+- changelog.md
 - exe/arlo
 - lib/arlo.rb
 - lib/arlo/devices.rb
+- lib/arlo/init.rb
 - lib/arlo/library.rb
 - lib/arlo/network_helper.rb
 - lib/arlo/profile.rb
-- lib/arlo/token.rb
 - lib/arlo/version.rb
 homepage: https://github.com/ihassin/arlo
 licenses: