togglehq 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec05a3d9b1ca854f13bd1eb2e240a51b59789e65
-  data.tar.gz: 84ffb1d582688afdcf054d9cbf68e76d4d284f91
+  metadata.gz: cad499d2b55fe1f98f70828478da19bec368ede3
+  data.tar.gz: a91488b597f4dceea5325c562d5261da09bc4233
 SHA512:
-  metadata.gz: 130f1635f38c1d3aeb84c343f5916b19d9f118aa002e676442d384a0776a16a2b09a2285c77ea33bea2606fafc3214b986cf717176167bde0adb502648b0ab1f
-  data.tar.gz: 31fbd63d206b06f1a36591fa2f05dbed5ceda9b88944a5b9f6b31b14c6787ca0c359e17477c70bbfbb819196c99eef58d0161d26776936ec3e2cf53bf09d89b3
+  metadata.gz: 10b4188c6d029a88736b978d8d5338d4ac9bf3248e1dc76a8ae5267934fb54e7e3e0d041760062616ea156d7aba15a940aff395ba90c7564dc112e61a57247f0
+  data.tar.gz: 9ef900273e811106f7c0cb32a11520c40353daa5a3ea828b0425bf5a902b7506ea18581cb76c78b4992a0850ab7a62b289119399b52add6088835e39f5cb39e0

data/README.md

@@ -56,6 +56,33 @@ If a user with the given identifier cannot be found, `nil` will be returned.
 
 Alternatively, you can call `Togglehq::User.find_by_identifier!`, which will raise a RuntimeError if the given user cannot be found.
 
+### Devices
+
+Create a device (usually done via the ToggleHQ SDK)
+
+```ruby
+device = Togglehq::Device.new(:os => "ios", :os_version => 10.0, :manufacturer => "Apple", :model => "iPhone")
+device.save
+```
+If created successfully, `device.uuid` will return the unique device identifier.
+
+Enable a device to receive notifications
+```ruby
+device = Togglehq::Device.new(:uuid => "123456789")
+device.enable!("2b6f0cc4...831186")
+```
+
+Assign a device to a specific user
+```ruby
+device = Togglehq::Device.new(:uuid => "123456789")
+device.assign!("abcdef0123456789")
+```
+
+Unassign a device from all users
+```ruby
+device = Togglehq::Device.new(:uuid => "123456789")
+device.unassign!
+```
 
 ### ToggleHQ Notify Usage
 

data/lib/togglehq/device.rb

@@ -0,0 +1,75 @@
+module Togglehq
+  class Device
+    attr_accessor :os, :uuid, :os_version, :manufacturer, :model
+
+    def initialize(params = {})
+      @os = params[:os]
+      @uuid = params[:uuid]
+      @os_version = params[:os_version]
+      @manufacturer = params[:manufacturer]
+      @model = params[:model]
+    end
+
+    # Enables a device to receive notifications
+    # @param token [String] the token of the device
+    # @raise [RuntimeError] raised if the device is invalid or not found
+    def enable!(token)
+      response = Togglehq::Request.new("/devices/enable",{"device" => {"uuid" => self.uuid, "token" => token}}).patch!
+      if response.status == 200
+        return true
+      elsif response.status == 404
+        json = JSON.parse(response.body)
+        raise json["message"]
+      else
+        raise "unexpected error enabling the device"
+      end
+    end
+
+    # Assigns a device to a specific user
+    # @param user_identifier [String] the identifier of the user
+    # @raise [RuntimeError] raised if either the device or user is invalid or not found
+    def assign!(user_identifier)
+      response = Togglehq::Request.new("/devices/assign",{"device" => {"uuid" => self.uuid}, "user" => {"identifier" => user_identifier}}).patch!
+      if response.status == 200
+        return true
+      elsif response.status == 404
+        json = JSON.parse(response.body)
+        raise json["message"]
+      else
+        raise "unexpected error assigning the device"
+      end
+    end
+
+    # Unassigns a device from all users
+    # @raise [RuntimeError] raised if either the device or user is invalid or not found
+    def unassign!
+      response = Togglehq::Request.new("/devices/unassign",{"device" => {"uuid" => self.uuid}}).patch!
+      if response.status == 200
+        return true
+      elsif response.status == 404
+        json = JSON.parse(response.body)
+        raise json["message"]
+      else
+        raise "unexpected error unassigning the device"
+      end
+    end
+
+    # Saves a new device
+    def save
+      response = Togglehq::Request.new("/devices", {"device" => {"os" => self.os, "os_version" => self.os_version, "manufacturer" => self.manufacturer, "model" => self.model}}).post!
+      if response.status == 200
+        self.persisted!
+        json = JSON.parse(response.body)
+        self.uuid = json["device"]["uuid"]
+        return true
+      else
+        raise "unexpected error saving the device"
+      end
+    end
+
+    # @private
+    def persisted!
+      @persisted = true
+    end
+  end
+end

data/lib/togglehq/version.rb

@@ -1,3 +1,3 @@
 module Togglehq
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/togglehq.rb

@@ -1,6 +1,7 @@
 require 'togglehq/version'
 require 'togglehq/config'
 require 'togglehq/request'
+require 'togglehq/device'
 require 'togglehq/user'
 require 'logger'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: togglehq
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Toggle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,6 +154,7 @@ files:
 - bin/setup
 - lib/togglehq.rb
 - lib/togglehq/config.rb
+- lib/togglehq/device.rb
 - lib/togglehq/notify.rb
 - lib/togglehq/notify/notification.rb
 - lib/togglehq/notify/preferences.rb