apple_dep_client 2.0.0 → 2.0.1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.0.1 (2015-10-30)
+
+Features:
+
+ - Allow newer versions of typhoeus
+ - Run rubocop and fix coding style issues
+
 ## 2.0.0 (2015-09-23)
 
 Features:

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing to AppleDEPClient
+
+Pull Requests and Issues are welcome for this repository.
+
+## Setup
+
+```shell
+bundle install
+```
+
+## Tests
+
+```shell
+bundle exec rake
+```
+
+Please write spec tests in the appropriate file in https://github.com/cellabus/apple_dep_client/tree/master/spec
+for any changes you write.  You can also manually test
+your changes by running the example scripts in https://github.com/cellabus/apple_dep_client/tree/master/example.

data/Gemfile

@@ -1,7 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in apple_dep_client.gemspec
 gemspec
 
 # This isn't in the gemspec file because it is being read from github
-gem 'plist', git: 'https://github.com/cellabus/plist', ref: '3.1.2' # Used to handle responses in plist format
+gem "plist", git: "https://github.com/cellabus/plist", ref: "3.1.2" # Used to handle responses in plist format

data/Rakefile

@@ -1,5 +1,5 @@
 require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec

data/apple_dep_client.gemspec

@@ -1,16 +1,16 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'apple_dep_client/version'
+require "apple_dep_client/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "apple_dep_client"
   spec.version       = AppleDEPClient::VERSION
-  spec.licenses      = ['MIT']
+  spec.licenses      = ["MIT"]
   spec.authors       = ["Albert Wang"]
   spec.email         = ["albert@cellabus.com"]
-  spec.summary       = %q{Client for Apple Device Enrollment Program}
-  spec.description   = %q{This gem provides an easy way to authenticate and interact with Apple's Device Enrollment Program}
+  spec.summary       = "Client for Apple Device Enrollment Program"
+  spec.description   = "This gem provides an easy way to authenticate and interact with Apple's Device Enrollment Program"
   spec.homepage      = "https://github.com/cellabus/apple_dep_client"
 
   spec.files         = `git ls-files`.split($/)
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "oauth", "~> 0.4.7"
-  spec.add_dependency "typhoeus", "~> 0.7.1"
+  spec.add_dependency "typhoeus", "~> 0.7"
   spec.add_dependency "plist", "~> 3.1.0" # See Gemfile
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10"

data/example/example.rb

@@ -1,12 +1,12 @@
 # This file is an example script prepopulated with data for depsim, Apple's
 # DEP simulator
 
-require 'apple_dep_client'
-require 'securerandom'
+require "apple_dep_client"
+require "securerandom"
 
 # depsim
 AppleDEPClient.configure do |x|
-  x.apple_dep_server = 'http://localhost'
+  x.apple_dep_server = "http://localhost"
   x.consumer_key = "CK_48dd68d198350f51258e885ce9a5c37ab7f98543c4a697323d75682a6c10a32501cb247e3db08105db868f73f2c972bdb6ae77112aea803b9219eb52689d42e6"
   x.consumer_secret = "CS_34c7b2b531a600d99a0e4edcf4a78ded79b86ef318118c2f5bcfee1b011108c32d5302df801adbe29d446eb78f02b13144e323eb9aad51c79f01e50cb45c3a68"
   x.access_token = "AT_927696831c59ba510cfe4ec1a69e5267c19881257d4bca2906a99d0785b785a6f6fdeb09774954fdd5e2d0ad952e3af52c6d8d2f21c924ba0caf4a031c158b89"
@@ -14,30 +14,30 @@ AppleDEPClient.configure do |x|
 end
 
 device_serials = []
-p 'Devices:'
+p "Devices:"
 AppleDEPClient::Device.fetch do |device|
   p device
-  device_serials << device['serial_number']
+  device_serials << device["serial_number"]
 end
 
 DEFAULT_DEP_PROFILE_DATA = {
-  profile_name: 'DEP Profile',
-  url: 'http://localhost:5000/dep_checkin',
+  profile_name: "DEP Profile",
+  url: "http://localhost:5000/dep_checkin",
   is_supervised: true,
   is_mandatory: true,
   is_mdm_removable: false,
-  support_phone_number: '123-456-7890',
-  support_email_address: 'support@cellabus.com',
+  support_phone_number: "123-456-7890",
+  support_email_address: "support@cellabus.com",
   org_magic: SecureRandom.uuid,
   skip_setup_items: [:biometric, :siri],
-  department: 'Foo',
+  department: "Foo",
 }
 
 profile = AppleDEPClient::Profile.define(DEFAULT_DEP_PROFILE_DATA)
-profile_uuid = profile['profile_uuid']
-p 'Profile UUID:'
+profile_uuid = profile["profile_uuid"]
+p "Profile UUID:"
 p profile_uuid
-p 'Assigning profile to devices:'
+p "Assigning profile to devices:"
 p AppleDEPClient::Profile.assign(profile_uuid, device_serials)
-p 'Fetching profile info:'
+p "Fetching profile info:"
 p AppleDEPClient::Profile.fetch(profile_uuid)

data/lib/apple_dep_client.rb

@@ -1,16 +1,16 @@
-require 'apple_dep_client/version'
-require 'apple_dep_client/error'
-require 'apple_dep_client/configuration'
+require "apple_dep_client/version"
+require "apple_dep_client/error"
+require "apple_dep_client/configuration"
 
 module AppleDEPClient
   extend Configuration
 end
 
-require 'apple_dep_client/token'
-require 'apple_dep_client/auth'
-require 'apple_dep_client/callback'
+require "apple_dep_client/token"
+require "apple_dep_client/auth"
+require "apple_dep_client/callback"
 
-require 'apple_dep_client/request'
-require 'apple_dep_client/account'
-require 'apple_dep_client/device'
-require 'apple_dep_client/profile'
+require "apple_dep_client/request"
+require "apple_dep_client/account"
+require "apple_dep_client/device"
+require "apple_dep_client/profile"

data/lib/apple_dep_client/account.rb

@@ -4,7 +4,7 @@ module AppleDEPClient
   module Account
     FETCH_PATH = "/account"
     def self.fetch
-      AppleDEPClient::Request.make_request(AppleDEPClient::Request.make_url(FETCH_PATH), :get, '')
+      AppleDEPClient::Request.make_request(AppleDEPClient::Request.make_url(FETCH_PATH), :get, "")
     end
   end
 end

data/lib/apple_dep_client/auth.rb

@@ -1,10 +1,10 @@
 # Apple Session Authorization Token management
 
-require 'json'
-require 'oauth'
-require File.join(File.dirname(__FILE__), 'hacks', 'typhoeus_request')
-require 'securerandom'
-require 'typhoeus'
+require "json"
+require "oauth"
+require File.join(File.dirname(__FILE__), "hacks", "typhoeus_request")
+require "securerandom"
+require "typhoeus"
 
 module AppleDEPClient
   module Auth
@@ -14,16 +14,16 @@ module AppleDEPClient
     OAUTH_PATH = "/session"
 
     def self.get_session_token
-      options = {method: :get, headers: AppleDEPClient::Request::DEFAULT_HEADERS}
+      options = { method: :get, headers: AppleDEPClient::Request::DEFAULT_HEADERS }
       request = Typhoeus::Request.new(AppleDEPClient::Request.make_url(OAUTH_PATH), options)
-      request.options[:headers].merge!({'Authorization' => oauth_header(request)})
+      request.options[:headers].merge!({ "Authorization" => oauth_header(request) })
       request.run
       response = request.response
-      AppleDEPClient::Error.check_request_error(response, auth:true)
+      AppleDEPClient::Error.check_request_error(response, auth: true)
       parse_response response
     end
 
-    def self.oauth_header request
+    def self.oauth_header(request)
       consumer = OAuth::Consumer.new(
         AppleDEPClient.consumer_key,
         AppleDEPClient.consumer_secret,
@@ -36,16 +36,16 @@ module AppleDEPClient
       )
       oauth_params = {
         consumer: consumer,
-        realm: 'ADM',
+        realm: "ADM",
         token: token,
       }
       oauth_helper = OAuth::Client::Helper.new request, oauth_params.merge(request_uri: AppleDEPClient::Request.make_url(OAUTH_PATH))
       oauth_helper.header
     end
 
-    def self.parse_response response
+    def self.parse_response(response)
       body = JSON.parse response.response_body
-      auth_session_token = body['auth_session_token']
+      auth_session_token = body["auth_session_token"]
     end
   end
 end

data/lib/apple_dep_client/callback.rb

@@ -1,10 +1,9 @@
 # Processing the device callback
 
-require 'plist'
+require "plist"
 
 module AppleDEPClient
   module Callback
-
     # Given an XML plist that is CMS-signed and DER encoded, return a ruby Hash
     # of the data
     def self.decode_callback(callback_data)
@@ -13,11 +12,11 @@ module AppleDEPClient
     end
 
     def self.decrypt_data(callback_data)
-      data = AppleDEPClient::Token.create_temp_file('data', callback_data, binary: true)
+      data = AppleDEPClient::Token.create_temp_file("data", callback_data, binary: true)
       command = "openssl asn1parse -inform DER -in #{data.path}"
       decrypted_data, errors = AppleDEPClient::Token.run_command command
       AppleDEPClient::Token.remove_temp_file data
-      if decrypted_data == '' or errors != ''
+      if decrypted_data == "" || errors != ""
         raise AppleDEPClient::Error::CallbackError, "Incorrect data #{errors}"
       end
       remove_encryption_data(decrypted_data)
@@ -29,11 +28,11 @@ module AppleDEPClient
       callback_data = callback_data.split
       read = false
       callback_data.select! do |line|
-        if line.include? '<!DOCTYPE'
+        if line.include? "<!DOCTYPE"
           read = true
         end
         read_line = read
-        if line.include? '</plist>'
+        if line.include? "</plist>"
           read = false
         end
         read_line

data/lib/apple_dep_client/configuration.rb

@@ -11,15 +11,15 @@ module AppleDEPClient
       access_token: nil,
       access_secret: nil,
       access_token_expiry: nil,
-      apple_dep_server: 'https://mdmenrollment.apple.com', # Domain that Apple's DEP servers are at
-      user_agent: 'CellabusMDM',
+      apple_dep_server: "https://mdmenrollment.apple.com", # Domain that Apple's DEP servers are at
+      user_agent: "CellabusMDM",
     }
 
     DEP_CONFIG.freeze
 
     attr_writer *DEP_CONFIG.keys
 
-    def method_missing(m, *args, &block)
+    def method_missing(m, *_args, &_block)
       if DEP_CONFIG.keys.include? m.to_sym
         get_value(m)
       else
@@ -28,9 +28,9 @@ module AppleDEPClient
     end
 
     def get_value(m)
-      value = self.instance_variable_get("@#{m}")
+      value = instance_variable_get("@#{m}")
       value = get_default_value(m) if value.nil?
-      (value.is_a? Proc)? value.call : value
+      (value.is_a? Proc) ? value.call : value
     end
 
     def get_default_value(key)

data/lib/apple_dep_client/device.rb

@@ -1,6 +1,6 @@
 # Methods for getting and setting device details
 
-require 'json'
+require "json"
 
 module AppleDEPClient
   module Device
@@ -12,23 +12,23 @@ module AppleDEPClient
 
     def self.fetch(cursor: nil, url: nil)
       url ||= FETCH_PATH
-      response = {'cursor'=>cursor, 'more_to_follow'=> 'true' }
-      while response['more_to_follow'] == 'true'
-        response = make_fetch_request response['cursor'], url
-        response['devices'].each do |device|
+      response = { "cursor" => cursor, "more_to_follow" => "true" }
+      while response["more_to_follow"] == "true"
+        response = make_fetch_request response["cursor"], url
+        response["devices"].each do |device|
           yield device
         end
       end
-      return response['cursor']
+      response["cursor"]
     end
 
-    def self.make_fetch_request cursor, url
+    def self.make_fetch_request(cursor, url)
       body = fetch_body(cursor)
       AppleDEPClient::Request.make_request(AppleDEPClient::Request.make_url(url), :post, body)
     end
 
-    def self.fetch_body cursor
-      body = {"limit" => FETCH_LIMIT}
+    def self.fetch_body(cursor)
+      body = { "limit" => FETCH_LIMIT }
       if cursor
         body["cursor"] = cursor
       end
@@ -36,24 +36,24 @@ module AppleDEPClient
     end
 
     def self.sync(cursor, &block)
-      self.fetch(cursor:cursor, url: SYNC_PATH, &block)
+      fetch(cursor: cursor, url: SYNC_PATH, &block)
     end
 
     def self.details(devices)
       body = devices
       body = JSON.dump body
       response = AppleDEPClient::Request.make_request(AppleDEPClient::Request.make_url(DETAILS_PATH), :post, body)
-      response['devices']
+      response["devices"]
     end
 
     # Accepts an array of device ID strings
     # WARNING - this will remove devices from DEP accounts and
     # may render devices permanently inoperable
     def self.disown(devices)
-      body = {'devices' => devices}
+      body = { "devices" => devices }
       body = JSON.dump body
       response = AppleDEPClient::Request.make_request(AppleDEPClient::Request.make_url(DISOWN_PATH), :post, body)
-      response['devices']
+      response["devices"]
     end
   end
 end

data/lib/apple_dep_client/error.rb

@@ -2,52 +2,51 @@
 
 module AppleDEPClient
   module Error
-
     AUTH_ERRORS = [
       # Used by AppleDEPClient::Auth
-      ["BadRequest",          400, '' ],
-      ["Unauthorized",        401, '' ],
-      ["Forbidden",           403, '' ],
+      ["BadRequest",          400, ""],
+      ["Unauthorized",        401, ""],
+      ["Forbidden",           403, ""],
     ]
 
     ERRORS = [
       # Used by AppleDEPClient::Request
-      ["MalformedRequest",    400, 'MALFORMED_REQUEST_BODY' ],
-      ["Unauthorized",        401, 'UNAUTHORIZED' ],
-      ["Forbidden",           403, 'FORBIDDEN' ],
-      ["MethodNotAllowed",    405, '' ],
+      ["MalformedRequest",    400, "MALFORMED_REQUEST_BODY"],
+      ["Unauthorized",        401, "UNAUTHORIZED"],
+      ["Forbidden",           403, "FORBIDDEN"],
+      ["MethodNotAllowed",    405, ""],
 
       # Used by AppleDEPClient::Device
-      ["InvalidCursor",       400, 'INVALID_CURSOR' ],
-      ["ExhaustedCursor",     400, 'EXHAUSTED_CURSOR' ],
-      ["CursorRequired",      400, 'CURSOR_REQUIRED' ],
-      ["ExpiredCursor",       400, 'EXPIRED_CURSOR' ],
-      ["NotFound",            200, 'NOT_FOUND' ],
-      ["DeviceIDRequired",    400, 'DEVICE_ID_REQUIRED' ],
+      ["InvalidCursor",       400, "INVALID_CURSOR"],
+      ["ExhaustedCursor",     400, "EXHAUSTED_CURSOR"],
+      ["CursorRequired",      400, "CURSOR_REQUIRED"],
+      ["ExpiredCursor",       400, "EXPIRED_CURSOR"],
+      ["NotFound",            200, "NOT_FOUND"],
+      ["DeviceIDRequired",    400, "DEVICE_ID_REQUIRED"],
 
       # Used by AppleDEPClient::Profile
-      ["ConfigUrlRequired",   400, 'CONFIG_URL_REQUIRED' ],
-      ["ConfigNameRequired",  400, 'CONFIG_NAME_REQUIRED' ],
-      ["FlagsInvalid",        400, 'FLAGS_INVALID' ],
-      ["ConfigUrlInvalid",    400, 'CONFIG_URL_INVALID' ],
-      ["ConfigNameInvalid",   400, 'CONFIG_NAME_INVALID' ],
-      ["DepartmentInvalid",   400, 'DEPARTMENT_INVALID' ],
-      ["SupportPhoneInvalid", 400, 'SUPPORT_PHONE_INVALID' ],
-      ["SupportEmailInvalid", 400, 'SUPPORT_EMAIL_INVALID' ],
-      ["DescriptionInvalid",  400, 'DESCRIPTION_INVALID' ],
-      ["MagicInvalid",        400, 'MAGIC_INVALID' ],
-      ["ProfileUUIDRequired", 400, 'PROFILE_UUID_REQUIRED' ],
-      ["ProfileNotFound",     404, 'PROFILE_NOT_FOUND' ],
+      ["ConfigUrlRequired",   400, "CONFIG_URL_REQUIRED"],
+      ["ConfigNameRequired",  400, "CONFIG_NAME_REQUIRED"],
+      ["FlagsInvalid",        400, "FLAGS_INVALID"],
+      ["ConfigUrlInvalid",    400, "CONFIG_URL_INVALID"],
+      ["ConfigNameInvalid",   400, "CONFIG_NAME_INVALID"],
+      ["DepartmentInvalid",   400, "DEPARTMENT_INVALID"],
+      ["SupportPhoneInvalid", 400, "SUPPORT_PHONE_INVALID"],
+      ["SupportEmailInvalid", 400, "SUPPORT_EMAIL_INVALID"],
+      ["DescriptionInvalid",  400, "DESCRIPTION_INVALID"],
+      ["MagicInvalid",        400, "MAGIC_INVALID"],
+      ["ProfileUUIDRequired", 400, "PROFILE_UUID_REQUIRED"],
+      ["ProfileNotFound",     404, "PROFILE_NOT_FOUND"],
     ]
 
     def self.check_request_error(response, auth:false)
-      get_errors(auth:auth).each do |error_name, response_code, body|
+      get_errors(auth: auth).each do |error_name, response_code, body|
         if response.code == response_code && response.body.include?(body)
           raise RequestError, error_name
         end
       end
       if response.code != 200
-        raise RequestError, 'GenericError'
+        raise RequestError, "GenericError"
       end
     end
 
@@ -63,6 +62,5 @@ module AppleDEPClient
 
     class CallbackError < RuntimeError
     end
-
   end
 end