apple_class_client 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36338de926eaa3df5b04fa4e019f9aaa8af32840
-  data.tar.gz: 44f427bbe726a0b0a6c07b816de63f4dcc970421
+  metadata.gz: cf5ca3c450a74dc4dbf1f8cd9b09b6ce72ca48e8
+  data.tar.gz: 1f416edf07f9f13a9142616b22b85c3580427e38
 SHA512:
-  metadata.gz: 6e6ce022f18a97fc9f092c038c28f9f3d536dfd1292b5314ac652ae1c285db7fadc55fe0db4b1f42df464da1dec03d16bb410e6b2b2d3028da919abe01155065
-  data.tar.gz: b4462252a13ae125b63892ba47fd9387256404173f6fc46a992a547046a2f42285098f8e1aad23c489e7d07a1e68909991e76528957adad8108f5125ef090bb2
+  metadata.gz: e12f5ff91b5812b61bc4e234f8dab2a377fa26b7cb5492c5dd5c607a0e4aae0e6e72fa5f21ee67b7717fa291e48cdf0efc182dc9e9a6cbc0572e20220dd122f3
+  data.tar.gz: 1c4a46b7b2f31a6f483941b8a9447031244eca2414d157ad27a02f91a38aa47ffe71f6cb6400ba81999d433dbe71c02574a154a67f67a05d730da0c19252ea09

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.0.0 (2017-05-23)
+
+ - Initial release
+
+
 ## 0.0.0 (2016-05-15)
 
  - Gem scaffold

data/CODE_OF_CONDUCT.md

@@ -35,7 +35,7 @@ This code of conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at albert@cellabus.com. All
+reported by contacting a project maintainer at aywang31@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. Maintainers are
 obligated to maintain confidentiality with regard to the reporter of an

data/README.md

@@ -1,5 +1,9 @@
 # AppleClassClient
 
+[ ![Codeship Status for albertyw/apple_class_client](https://app.codeship.com/projects/9c364080-fd10-0133-688f-7e176884dbc2/status?branch=master)](https://app.codeship.com/projects/152119)
+[![Code Climate](https://codeclimate.com/github/albertyw/apple_class_client/badges/gpa.svg)](https://codeclimate.com/github/albertyw/apple_class_client)
+[![Dependency Status](https://gemnasium.com/badges/github.com/albertyw/apple_class_client.svg)](https://gemnasium.com/github.com/albertyw/apple_class_client)
+
 This is a client for accessing Apple MDM's class, person, location, and course rosters.
 
 ## Installation

data/apple_class_client.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "apple_class_client"
   spec.version       = AppleClassClient::VERSION
   spec.authors       = ["Albert Wang"]
-  spec.email         = ["albert@cellabus.com"]
+  spec.email         = ["aywang31@gmail.com"]
 
   spec.summary       = %q{Client for accessing Apple MDM class information}
   spec.description   = %q{This is a client for accessing Apple MDM's class, person, location, and course rosters.}
@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "oauth", "~> 0.4"
+  spec.add_dependency "typhoeus", [">= 0.7", "< 1.2"]
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 11.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/apple_class_client.rb

@@ -1,5 +1,10 @@
 require "apple_class_client/version"
+require "apple_class_client/configuration"
 
 module AppleClassClient
-  # Your code goes here...
+  extend Configuration
 end
+
+require "apple_class_client/auth"
+require "apple_class_client/error"
+require "apple_class_client/request"

data/lib/apple_class_client/auth.rb

@@ -0,0 +1,51 @@
+# Apple Session Authorization Token management
+
+require "json"
+require "oauth"
+require File.join(File.dirname(__FILE__), "hacks", "typhoeus_request")
+require "securerandom"
+require "typhoeus"
+
+module AppleClassClient
+  module Auth
+    # Apple requires a quirky OAuth 1.0a authentication to get a temporary
+    # X-ADM-Auth-Session key to make requests; this takes care of that
+
+    OAUTH_PATH = "/session"
+
+    def self.get_session_token
+      options = { method: :get, headers: AppleClassClient::Request::DEFAULT_HEADERS }
+      request = Typhoeus::Request.new(AppleClassClient::Request.make_url(OAUTH_PATH), options)
+      request.options[:headers].merge!({ "Authorization" => oauth_header(request) })
+      request.run
+      response = request.response
+      AppleClassClient::Error.check_request_error(response, auth: true)
+      parse_response response
+    end
+
+    def self.oauth_header(request)
+      consumer = OAuth::Consumer.new(
+        AppleClassClient.consumer_key,
+        AppleClassClient.consumer_secret,
+        site: AppleClassClient::Request.make_url(OAUTH_PATH),
+      )
+      token = OAuth::AccessToken.new(
+        consumer,
+        AppleClassClient.access_token,
+        AppleClassClient.access_secret,
+      )
+      oauth_params = {
+        consumer: consumer,
+        realm: "ADM",
+        token: token,
+      }
+      oauth_helper = OAuth::Client::Helper.new request, oauth_params.merge(request_uri: AppleClassClient::Request.make_url(OAUTH_PATH))
+      oauth_helper.header
+    end
+
+    def self.parse_response(response)
+      body = JSON.parse response.response_body
+      auth_session_token = body["auth_session_token"]
+    end
+  end
+end

data/lib/apple_class_client/configuration.rb

@@ -0,0 +1,44 @@
+# Configuration for AppleClassClient
+# Configuration values can be either literals or Procs; note that Procs will not
+# be overwritten by AppleClassClient::Token.save_data
+
+module AppleClassClient
+  module Configuration
+    CONFIG = {
+      private_key: nil,         # MDM Server's private key for decrypting token files
+      consumer_key: nil,        # Server Token information
+      consumer_secret: nil,
+      access_token: nil,
+      access_secret: nil,
+      access_token_expiry: nil,
+      apple_mdm_server: "https://mdmenrollment.apple.com", # Apple MDM server url
+      user_agent: "CellabusMDM",
+    }
+
+    CONFIG.freeze
+
+    attr_writer *CONFIG.keys
+
+    def method_missing(m, *_args, &_block)
+      if CONFIG.keys.include? m.to_sym
+        get_value(m)
+      else
+        raise NoMethodError, "Unknown method #{m}"
+      end
+    end
+
+    def get_value(m)
+      value = instance_variable_get("@#{m}")
+      value = get_default_value(m) if value.nil?
+      (value.is_a? Proc) ? value.call : value
+    end
+
+    def get_default_value(key)
+      CONFIG[key.to_sym]
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/apple_class_client/error.rb

@@ -0,0 +1,47 @@
+# Errors for AppleClassClient and Apple's endpoints
+
+require 'typhoeus'
+
+module AppleClassClient
+  module Error
+    AUTH_ERRORS = [
+      # Used by AppleClassClient::Auth
+      ["BadRequest",          400, ""],
+      ["Unauthorized",        401, ""],
+      ["Forbidden",           403, ""],
+    ]
+
+    ERRORS = [
+      # Server failures
+      ["InternalServerError", 500, ""],
+      ["ServiceUnavailable",  503, ""],
+
+      # Client errors
+      ["Unauthorized",        401, "UNAUTHORIZED"],
+      ["Forbidden",           403, "FORBIDDEN"],
+      ["MalformedRequest",    400, "MALFORMED_REQUEST_BODY"],
+      ["CursorRequired",      400, "CURSOR_REQUIRED"],
+      ["InvalidCursor",       400, "INVALID_CURSOR"],
+      ["ExpiredCursor",       400, "EXPIRED_CURSOR"],
+      ["TooManyRequests",     429, "TOO_MANY_REQUESTS"],
+    ]
+
+    def self.check_request_error(response, auth:false)
+      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"
+      end
+    end
+
+    def self.get_errors(auth:false)
+      auth ? AUTH_ERRORS : ERRORS
+    end
+
+    class RequestError < RuntimeError
+    end
+  end
+end

data/lib/apple_class_client/hacks/typhoeus_request.rb

@@ -0,0 +1,57 @@
+# This contains a few hacks that adds support for non-ancient versions of Typhoeus to
+# the ancient dead ruby oauth gem
+
+require "oauth/request_proxy/base"
+require "typhoeus"
+require "typhoeus/request"
+require "uri"
+require "cgi"
+
+module OAuth::RequestProxy::Typhoeus
+  class Request < OAuth::RequestProxy::Base
+    # Proxy for signing Typhoeus::Request requests
+    # Usage example:
+    # oauth_params = {:consumer => oauth_consumer, :token => access_token}
+    # req = Typhoeus::Request.new(uri, options)
+    # oauth_helper = OAuth::Client::Helper.new(req, oauth_params.merge(:request_uri => uri))
+    # req.headers.merge!({"Authorization" => oauth_helper.header})
+    # hydra = Typhoeus::Hydra.new()
+    # hydra.queue(req)
+    # hydra.run
+    # response = req.response
+    proxies Typhoeus::Request
+
+    def method
+      request_method = request.options[:method].to_s.upcase
+      request_method.empty? ? "GET" : request_method
+    end
+
+    def uri
+      options[:uri].to_s
+    end
+
+    def parameters
+      if options[:clobber_request]
+        options[:parameters]
+      else
+        post_parameters.merge(query_parameters).merge(options[:parameters] || {})
+      end
+    end
+
+    private
+
+    def query_parameters
+      query = URI.parse(request.url).query
+      query ? CGI.parse(query) : {}
+    end
+
+    def post_parameters
+      # Post params are only used if posting form data
+      if method == "POST"
+        OAuth::Helper.stringify_keys(request.params || {})
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/apple_class_client/request.rb

@@ -0,0 +1,41 @@
+# Wrapper around requests to MDM class endpoint
+# Will also handle any error conditions
+
+require "json"
+require "typhoeus"
+
+module AppleClassClient
+  module Request
+    DEFAULT_HEADERS = {
+      "User-Agent" => "#{AppleClassClient.user_agent}/#{AppleClassClient::VERSION}",
+      "X-Server-Protocol-Version" => "2",
+      "Content-Type" => "application/json;charset=UTF8",
+    }
+    DEFAULT_HEADERS.freeze
+
+    def self.make_request(url, query_type, body, params:nil, headers:nil)
+      if headers == nil
+        headers = make_headers
+      end
+      request = Typhoeus::Request.new(
+        url,
+        method: query_type,
+        body: body,
+        params: params,
+        headers: headers,
+      )
+      request.run
+      AppleClassClient::Error.check_request_error request.response
+      JSON.parse request.response.body
+    end
+
+    def self.make_headers
+      session_auth_token = AppleClassClient::Auth.get_session_token
+      DEFAULT_HEADERS.merge("X-ADM-Auth-Session" => session_auth_token)
+    end
+
+    def self.make_url(path)
+      AppleClassClient.apple_mdm_server + path
+    end
+  end
+end

data/lib/apple_class_client/version.rb

@@ -1,3 +1,3 @@
 module AppleClassClient
-  VERSION = "0.0.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,15 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: apple_class_client
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Albert Wang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-15 00:00:00.000000000 Z
+date: 2017-05-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -28,16 +62,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +89,7 @@ dependencies:
 description: This is a client for accessing Apple MDM's class, person, location, and
   course rosters.
 email:
-- albert@cellabus.com
+- aywang31@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -71,6 +105,11 @@ files:
 - bin/console
 - bin/setup
 - lib/apple_class_client.rb
+- lib/apple_class_client/auth.rb
+- lib/apple_class_client/configuration.rb
+- lib/apple_class_client/error.rb
+- lib/apple_class_client/hacks/typhoeus_request.rb
+- lib/apple_class_client/request.rb
 - lib/apple_class_client/version.rb
 homepage: https://github.com/albertyw/apple_class_client
 licenses: